@@ -2,14 +2,20 @@ Guidelines
2
2
---
3
3
4
4
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.
8
13
9
14
- When submitting a bug report:
10
15
- Please include a short, self-contained python snippet.
11
16
- Specify the pandas version used. (you can check ` pandas.__version__ ` ).
12
17
- Explain what the expected behavior was, and what you saw instead.
18
+
13
19
- When submitting a Pull Request
14
20
- ** Make sure the test suite passes** ., and that means on python3 as well.
15
21
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.
30
36
- An informal commit message format is in effect for the project, please try
31
37
and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in
32
38
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
34
40
release as it is worked on. Add entries to these files as needed in
35
41
a separate commit in your PR, documenting the fix, enhancement or (unavoidable)
36
- breaking change.
42
+ breaking change.
37
43
- For extra brownie points, use "git rebase -i" to squash and reorder
38
44
commits in your PR so that the history makes the most sense. Use your own
39
45
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.
40
57
41
58
Please see [ Developers] ( http://pandas.pydata.org/developers.html ) page on
42
59
the project website for more details.
0 commit comments