DOC: update contributing to pandas documentation #48113
Conversation
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -1,4 +1,5 @@ | |||
| - [ ] closes #xxxx (Replace xxxx with the Github issue number) | |||
| - [ ] xref #xxxx (Replace xxxx with the Github issue number) | |||
There was a problem hiding this comment.
Why was this added? I am concerned that it may be confusing with there also being closes #xxxx above
IMO we want to encourage the users to use closes #xxxx if applicable so it automatically closes the linked issue
There was a problem hiding this comment.
Yeah agreed. There are already many checkboxes you have to tick, would prefer to not add this
There was a problem hiding this comment.
Thanks @marenwestermann, nice update. Added couple of comments of things that I'd change. In the current docs, your changes look fine other than the template changes already mentioned.
| relevant GitHub issues in your commit message using GH1234 or #1234. Either style | ||
| is fine, but the former is generally preferred: | ||
| Finally, commit your changes to your local repository with an explanatory commit | ||
| message of ``< 80`` chars:: |
There was a problem hiding this comment.
| message of ``< 80`` chars:: | |
| message:: |
I know this already exists now, but since we squash commits, not very important, and we can simplify things a bit.
| Alternatively, you can just type ``git commit`` which opens an editor and use the | ||
| following commit message structure: | ||
|
|
||
| * a subject line with ``< 80`` chars. | ||
| * One blank line. | ||
| * Optionally, a commit message body. |
There was a problem hiding this comment.
I'd just delete all this.
|
Thanks for your feedback! I addressed your comments. I previously added the line |
|
Thanks @marenwestermann! |
* update contributing to pandas documentation * address requested changes * fix typo
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.I removed the part in the Committing your code section where it is said that commit messages should include the number of the GitHub issue the commit is contributing towards. I updated the pull request template to include cross references so that it's more clear how people should make use of referencing GitHub issues.
I fixed the code snippet
git commit -mwhich causes an error and updated the documentation to include both commit message versions, the one line commit message and the more detailed commit message that can be done with an editor. Let me know if you would like to keep both versions or would like further changes.Additionally, I moved the section about the prefixes to the Finally, make the pull request section of the documentation. Let me know if the prefixes need to be updated.