Skip to content

Commit 1af52c1

Browse files
author
y-p
committed
DOC: update CONTRIBUTING.MD
1 parent 815358d commit 1af52c1

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,20 @@ Guidelines
22
---
33

44
All contributions, bug reports, bug fixes, documentation improvments,
5-
enhancements and ideas are welcome. Please try and follow these guidelines
6-
as best you can, this makes it easier for us to accept your contribution or
7-
address the issue you're having.
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.
813

914
- When submitting a bug report:
1015
- Please include a short, self-contained python snippet.
1116
- Specify the pandas version used. (you can check `pandas.__version__`).
1217
- Explain what the expected behavior was, and what you saw instead.
18+
1319
- When submitting a Pull Request
1420
- **Make sure the test suite passes**., and that means on python3 as well.
1521
You can use "test_fast.sh", or tox locally and/or enable Travis-CI on your fork.
@@ -30,13 +36,24 @@ address the issue you're having.
3036
- An informal commit message format is in effect for the project, please try
3137
and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in
3238
your commit title. Check the output of "git log" for examples.
33-
- RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
39+
- RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
3440
release as it is worked on. Add entries to these files as needed in
3541
a separate commit in your PR, documenting the fix, enhancement or (unavoidable)
36-
breaking change.
42+
breaking change.
3743
- For extra brownie points, use "git rebase -i" to squash and reorder
3844
commits in your PR so that the history makes the most sense. Use your own
3945
judgment to decide what history needs to be preserved.
46+
- On the subject of [PEP8](http://www.python.org/dev/peps/pep-0008/): yes.
47+
- On the subject of massive PEP8 fix PRs touching everything, please consider the following:
48+
- They create merge conflicts for people working in their own fork.
49+
- They makes git blame less effective.
50+
- Different tools / people achieve PEP8 in different styles. This can create
51+
"style wars" and churn that produces little real benefit.
52+
- If your code changes are intermixed with style fixes, they are harder to review
53+
before merging. Keep style fixes in separate commits.
54+
- it's fine to clean-up a little around an area you just worked on.
55+
56+
Having said that, if you still feel a PEP8 storm is in order, go for it.
4057

4158
Please see [Developers](http://pandas.pydata.org/developers.html) page on
4259
the project website for more details.

0 commit comments

Comments
 (0)