Skip to content

Commit c15b902

Browse files
author
y-p
committed
DOC: update CONTRIBUTING.md
1 parent 455ab71 commit c15b902

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ your contribution or address the issue you're having.
2323
to see that the PR does indeed pass all the tests.
2424
- Back-compatiblitiy **really** matters. Pandas already has a large user-base and
2525
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.
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.
3030
- Performance matters. You can use the included "test_perf.sh"
3131
script to make sure your PR does not introduce any performance regressions
3232
in the library.
@@ -43,6 +43,8 @@ your contribution or address the issue you're having.
4343
- BLD: Updates to the build process/scripts
4444
- PERF: Performance improvement
4545
- 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.
4648
- RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
4749
release as it is worked on. Add entries to these files as needed in
4850
a separate commit in your PR, documenting the fix, enhancement or (unavoidable)

0 commit comments

Comments
 (0)