Skip to content

Commit 23a2985

Browse files
author
y-p
committed
DOC: put contribution guidelines in CONTRIBUTING.md
1 parent 128e956 commit 23a2985

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

CONTRIBUTING.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
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. 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.
8+
9+
- When submitting a bug report:
10+
- Please include a short, self-contained python snippet.
11+
- Specify the pandas version used. (you can check `pandas.__version__`).
12+
- Explain what the expected behavior was, and what you saw instead.
13+
- When submitting a Pull Request
14+
- **Make sure the test suite passes**., and that means on python3 as well.
15+
You can use "test_fast.sh", or tox locally and/or enable Travis-CI on you're fork.
16+
- We suggest you enable Travis-CI on your fork, to make it easier for the team
17+
to see that the PR does indeed pass all the tests.
18+
- Pandas cares about performance, you can use the included "test_perf.sh"
19+
script to make sure your PR does not introduce any performance regressions
20+
in the library.
21+
- **Don't** merge upstream into a branch you're going to submit as a PR,
22+
This can create all sorts of problems. Use "git rebase" instead. This ensures
23+
no merge conflicts occur when you're code is merged by the core team.
24+
- An informal commit message format is in use by the project, please try
25+
and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in
26+
your commit title. Check the output of "git log" for examples.
27+
- doc/source/vx.y.z.txt contains an on-going change-log for the version under
28+
development, look at previous versions, and add an entry as needed in
29+
a separate commit in your PR.
30+
- For extra brownie points, use "git rebase -i" to squash and reorder
31+
commits in your PR so that the history makes the most sense. Use your own
32+
judgment to decide what history needs to be preserved.
33+
34+
Please see [Developers](http://pandas.pydata.org/developers.html) page on
35+
the project website for more details.

0 commit comments

Comments
 (0)