@@ -15,18 +15,25 @@ address the issue you're having.
15
15
You can use "test_fast.sh", or tox locally and/or enable Travis-CI on you're fork.
16
16
- We suggest you enable Travis-CI on your fork, to make it easier for the team
17
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"
18
+ - Back-compatiblitiy ** really** matters. Pandas already has a large user-base and
19
+ a lot of existing user code. Don't break old code if you can avoid it
20
+ Explain the need if there is one in the PR.
21
+ Changes to method signatures should be made in a way which doesn't break existing
22
+ code, for example you should beware of changes to ordering and naming of keyword
23
+ arguments. Add deprecation warnings when needed.
24
+ - Performance matters. You can use the included "test_perf.sh"
19
25
script to make sure your PR does not introduce any performance regressions
20
26
in the library.
21
27
- ** Don't** merge upstream into a branch you're going to submit as a PR,
22
28
This can create all sorts of problems. Use "git rebase" instead. This ensures
23
29
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
30
+ - An informal commit message format is in effect for the project, please try
25
31
and adhere to it. Use a "ENH: ", "TST:", "BUG:", "DOC:", etc' prefix in
26
32
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.
33
+ - RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
34
+ release as it is worked on. Add entries to these files as needed in
35
+ a separate commit in your PR, documenting the fix, enhancement or (unavoidable)
36
+ breaking change.
30
37
- For extra brownie points, use "git rebase -i" to squash and reorder
31
38
commits in your PR so that the history makes the most sense. Use your own
32
39
judgment to decide what history needs to be preserved.
0 commit comments