Skip to content

DOC: Updates to CONTRIBUTING.md #4719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ your contribution or address the issue you're having.
- **Make sure the test suite passes**., and that means on python3 as well.
You can use "test_fast.sh", or tox locally and/or enable Travis-CI on your fork.
See the "Getting Travis-CI going" below.
- We suggest you enable Travis-CI on your fork, to make it easier for the team
to see that the PR does indeed pass all the tests.
- If you are changing any code, you need to enable Travis-CI on your fork,
to make it easier for the team to see that the PR does indeed pass all the tests.
- Back-compatibility **really** matters. Pandas already has a large user-base and
a lot of existing user code. Don't break old code if you can avoid it
Explain the need if there is one in the PR.
Expand Down Expand Up @@ -69,7 +69,8 @@ your contribution or address the issue you're having.
with self.assertRaises(ValueError):
foo

which fails on python 2.6, use `self.assertRaises(TheException,func,args)` instead.
which fails on python 2.6. You need to use `assertRaises` from
`pandas.util.testing` instead (or use `self.assertRaises(TheException,func,args)`).

- doc/source/release.rst and doc/source/vx.y.z.txt contain an on-going
changelog for each release as it is worked on. Add entries to these files
Expand Down