Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: update contributing to pandas documentation #48113

Merged
merged 3 commits into from
Sep 1, 2022
Merged

DOC: update contributing to pandas documentation #48113

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
629cbe1
update contributing to pandas documentation
marenwestermann Aug 16, 2022
2658a34
address requested changes
marenwestermann Aug 22, 2022
f17832e
fix typo
marenwestermann Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
- [ ] closes #xxxx (Replace xxxx with the Github issue number)
- [ ] xref #xxxx (Replace xxxx with the Github issue number)
Copy link
Member

@mroeschke mroeschke Aug 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah agreed. There are already many checkboxes you have to tick, would prefer to not add this

- [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature
- [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
- [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions.
Expand Down
47 changes: 23 additions & 24 deletions doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,31 +194,18 @@ Doing 'git status' again should give something like::
# modified: /relative/path/to/file-you-added.py
#

Finally, commit your changes to your local repository with an explanatory message. pandas
uses a convention for commit message prefixes and layout. Here are
some common prefixes along with general guidelines for when to use them:

* ENH: Enhancement, new functionality
* BUG: Bug fix
* DOC: Additions/updates to documentation
* TST: Additions/updates to tests
* BLD: Updates to the build process/scripts
* PERF: Performance improvement
* TYP: Type annotations
* CLN: Code cleanup

The following defines how a commit message should be structured. Please reference the
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::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.


git commit -m "your commit message goes here"

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just delete all this.


Now you can commit your changes in your local repository::

git commit -m

.. _contributing.push-code:

Pushing your changes
Expand Down Expand Up @@ -262,16 +249,28 @@ double check your branch changes against the branch it was based on:
Finally, make the pull request
------------------------------

If everything looks good, you are ready to make a pull request. A pull request is how
If everything looks good, you are ready to make a pull request. A pull request is how
code from a local repository becomes available to the GitHub community and can be looked
at and eventually merged into the main version. This pull request and its associated
at and eventually merged into the main version. This pull request and its associated
changes will eventually be committed to the main branch and available in the next
release. To submit a pull request:
release. To submit a pull request:

#. Navigate to your repository on GitHub
#. Click on the ``Pull Request`` button
#. Click on the ``Compare & pull request`` button
#. You can then click on ``Commits`` and ``Files Changed`` to make sure everything looks
okay one last time
#. Write a descriptive title that inlcudes prefixes. pandas uses a convention for title
prefixes. Here are some common ones along with general guidelines for when to use them:

* ENH: Enhancement, new functionality
* BUG: Bug fix
* DOC: Additions/updates to documentation
* TST: Additions/updates to tests
* BLD: Updates to the build process/scripts
* PERF: Performance improvement
* TYP: Type annotations
* CLN: Code cleanup

#. Write a description of your changes in the ``Preview Discussion`` tab
#. Click ``Send Pull Request``.

Expand Down