From 629cbe12bc5e1dcaefcb6e7da26e3f2d71119649 Mon Sep 17 00:00:00 2001 From: Maren Westermann Date: Tue, 16 Aug 2022 20:46:16 +0200 Subject: [PATCH 1/3] update contributing to pandas documentation --- .github/PULL_REQUEST_TEMPLATE.md | 1 + doc/source/development/contributing.rst | 47 ++++++++++++------------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 876e5e2cfbb1e..e47efc51acf0d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,5 @@ - [ ] closes #xxxx (Replace xxxx with the Github issue number) +- [ ] xref #xxxx (Replace xxxx with the Github issue number) - [ ] [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. diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index e76197e302ca4..6e33455dd713d 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -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:: + + 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. -Now you can commit your changes in your local repository:: - - git commit -m - .. _contributing.push-code: Pushing your changes @@ -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``. From 2658a34d3a1799fbffce737bde47682aaf366b33 Mon Sep 17 00:00:00 2001 From: Maren Westermann Date: Mon, 22 Aug 2022 15:59:59 +0200 Subject: [PATCH 2/3] address requested changes --- .github/PULL_REQUEST_TEMPLATE.md | 1 - doc/source/development/contributing.rst | 9 +-------- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e47efc51acf0d..876e5e2cfbb1e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,4 @@ - [ ] closes #xxxx (Replace xxxx with the Github issue number) -- [ ] xref #xxxx (Replace xxxx with the Github issue number) - [ ] [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. diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 6e33455dd713d..e2855ea851b8d 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -195,17 +195,10 @@ Doing 'git status' again should give something like:: # Finally, commit your changes to your local repository with an explanatory commit -message of ``< 80`` chars:: +message:: 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. - .. _contributing.push-code: Pushing your changes From f17832e2e10f7c8e49b429eeaab4b6849dc2ca58 Mon Sep 17 00:00:00 2001 From: Maren Westermann Date: Mon, 22 Aug 2022 16:18:35 +0200 Subject: [PATCH 3/3] fix typo --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index e2855ea851b8d..fe4cb005248f3 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -252,7 +252,7 @@ release. To submit a pull request: #. 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 +#. Write a descriptive title that includes 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