Skip to content

Commit d898901

Browse files
author
y-p
committed
DOC: explain travis-ci in CONTRIBUTING.md for the non-cognisanti
1 parent 5afb0eb commit d898901

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

CONTRIBUTING.md

+43-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Guidelines
2-
---
1+
###Guidelines
32

43
All contributions, bug reports, bug fixes, documentation improvments,
54
enhancements and ideas are welcome.
@@ -18,7 +17,8 @@ your contribution or address the issue you're having.
1817

1918
- When submitting a Pull Request
2019
- **Make sure the test suite passes**., and that means on python3 as well.
21-
You can use "test_fast.sh", or tox locally and/or [enable Travis-CI](http://about.travis-ci.org/docs/user/getting-started/) on your fork.
20+
You can use "test_fast.sh", or tox locally and/or enable Travis-CI on your fork.
21+
See the "Getting Travis-CI going" below.
2222
- We suggest you enable Travis-CI on your fork, to make it easier for the team
2323
to see that the PR does indeed pass all the tests.
2424
- Back-compatiblitiy **really** matters. Pandas already has a large user-base and
@@ -78,5 +78,45 @@ your contribution or address the issue you're having.
7878

7979
Having said that, if you still feel a PEP8 storm is in order, go for it.
8080

81+
###Getting Travis-CI going
82+
83+
Instructions for getting Travis-CI installed are available [here](http://about.travis-ci.org/docs/user/getting-started/). For those users who are new to travis-ci and continuous-integration in particular,
84+
Here's a few high-level notes:
85+
- Travis-CI is a free service (with premium account available), that integrates
86+
well with Github.
87+
- Enabling Travis-CI on your github fork of a project will cause any *new* commit
88+
pushed to the repo to trigger a full build+test on Travis-CI's servers.
89+
- All the configuration for travis's builds is already specified by .travis.yml in the repo,
90+
That means all you have to do is enable Travis-CI once, and then just push commits
91+
and you'll get full testing across py2/3 with pandas's considerable test-suite.
92+
- Enabling travis-CI will attach the test results (red/green) to the Pull-Request
93+
page for any PR you submit. For example:
94+
95+
https://github.com/pydata/pandas/pull/2532,
96+
97+
See the Green "Good to merge!" banner? that's it.
98+
99+
This is especially important for new contributors, as memebers of the pandas dev team
100+
like to know the test suite passes before considering it for merging.
101+
Even regular contributors who test religiously on their local box (using tox
102+
for example) often rely on a PR+travis=green to make double sure everything
103+
works ok on another system, as occasionally, it doesn't.
104+
105+
####Steps to enable Travis-CI
106+
107+
- go to https://travis-ci.org/
108+
- "Sign in with Github", on top panel.
109+
- \[your username\]/Account, on top-panel.
110+
- 'sync now' to refresh the list of repos on your GH account.
111+
- flip the switch on the repos you want Travis-CI enabled for,
112+
"pandas" obviously.
113+
114+
- Then, pushing a *new* commit to a certain branch on that repo
115+
will trigger a build/test for that branch, for example the branch
116+
might be "master" or "PR1234_fix_all_the_things", if that's the
117+
name of your PR branch.
118+
119+
####More developer docs
120+
81121
Please see [Developers](http://pandas.pydata.org/developers.html) page on
82122
the project website for more details.

0 commit comments

Comments
 (0)