|
1 |
| -Please see [Developers](http://pandas.pydata.org/developers.html) page on the project website. |
| 1 | +Guidelines |
| 2 | +--- |
| 3 | + |
| 4 | +All contributions, bug reports, bug fixes, documentation improvments, |
| 5 | +enhancements and ideas are welcome. |
| 6 | + |
| 7 | +The Github "issues" tab contains some issues labels "Good as first PR", these are |
| 8 | +tasks which do not require deep knowledge of the package. Look those up if you're |
| 9 | +looking for a quick way to help out. |
| 10 | + |
| 11 | +Please try and follow these guidelines, as this makes it easier for us to accept |
| 12 | +your contribution or address the issue you're having. |
| 13 | + |
| 14 | +- When submitting a bug report: |
| 15 | + - Please include a short, self-contained python snippet. |
| 16 | + - Specify the pandas version used. (you can check `pandas.__version__`). |
| 17 | + - Explain what the expected behavior was, and what you saw instead. |
| 18 | + |
| 19 | +- When submitting a Pull Request |
| 20 | + - **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 on your fork. |
| 22 | + - We suggest you enable Travis-CI on your fork, to make it easier for the team |
| 23 | + to see that the PR does indeed pass all the tests. |
| 24 | + - Back-compatiblitiy **really** matters. Pandas already has a large user-base and |
| 25 | + a lot of existing user code. Don't break old code if you can avoid it |
| 26 | + Explain the need if there is one in the PR. |
| 27 | + Changes to method signatures should be made in a way which doesn't break existing |
| 28 | + code, for example you should beware of changes to ordering and naming of keyword |
| 29 | + arguments. Add deprecation warnings when needed. |
| 30 | + - Performance matters. You can use the included "test_perf.sh" |
| 31 | + script to make sure your PR does not introduce any performance regressions |
| 32 | + in the library. |
| 33 | + - **Don't** merge upstream into a branch you're going to submit as a PR, |
| 34 | + This can create all sorts of problems. Use "git rebase" instead. This ensures |
| 35 | + no merge conflicts occur when you're code is merged by the core team. |
| 36 | + - An informal commit message format is in effect for the project, please try |
| 37 | + and adhere to it. View "git log" for examples. Here are some common prefixes |
| 38 | + along with general guidelines for when to use them: |
| 39 | + - ENH: Enhancement, new functionality |
| 40 | + - BUG: Bug fix |
| 41 | + - DOC: Additions/updates to documentation |
| 42 | + - TST: Additions/updates to tests |
| 43 | + - BLD: Updates to the build process/scripts |
| 44 | + - PERF: Performance improvement |
| 45 | + - CLN: Code cleanup |
| 46 | + - Commit messages should have subject line <80 chars, followed by one blank line, |
| 47 | + and finally a commit message body if there's a need for one. |
| 48 | + - Please reference the GH issue number in your commit message using GH1234 |
| 49 | + or #1234, either style is fine. |
| 50 | + - RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each |
| 51 | + release as it is worked on. Add entries to these files as needed in |
| 52 | + a separate commit in your PR, documenting the fix, enhancement or (unavoidable) |
| 53 | + breaking change. |
| 54 | + - For extra brownie points, use "git rebase -i" to squash and reorder |
| 55 | + commits in your PR so that the history makes the most sense. Use your own |
| 56 | + judgment to decide what history needs to be preserved. |
| 57 | + - On the subject of [PEP8](http://www.python.org/dev/peps/pep-0008/): yes. |
| 58 | + - On the subject of massive PEP8 fix PRs touching everything, please consider the following: |
| 59 | + - They create merge conflicts for people working in their own fork. |
| 60 | + - They makes git blame less effective. |
| 61 | + - Different tools / people achieve PEP8 in different styles. This can create |
| 62 | + "style wars" and churn that produces little real benefit. |
| 63 | + - If your code changes are intermixed with style fixes, they are harder to review |
| 64 | + before merging. Keep style fixes in separate commits. |
| 65 | + - it's fine to clean-up a little around an area you just worked on. |
| 66 | + |
| 67 | + Having said that, if you still feel a PEP8 storm is in order, go for it. |
| 68 | + |
| 69 | +Please see [Developers](http://pandas.pydata.org/developers.html) page on |
| 70 | +the project website for more details. |
0 commit comments