-
-
Notifications
You must be signed in to change notification settings - Fork 421
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WIP] Added new PR template. (#1010)
* Added new PR template * Add temlates for bug-fix, documentation and new features * changed the templates * final changes in the template * final changes to the PR template * added the changelog check to PR template * modified changelog check * Minor changes * Update bug-fix.md minor fix * Update documentation.md minor fix * Update new-feature.md * Update new-feature.md Co-authored-by: Osvaldo Martin <aloctavodia@gmail.com>
- Loading branch information
1 parent
a73d7f0
commit 285ed3d
Showing
3 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| ## Description | ||
| <!-- | ||
| Thank you so much for your PR! To help us review your contribution, please | ||
| consider the following points: | ||
| - The PR title should summarize the changes, for example "Add new group argument for the | ||
| pair plot". Avoid non-descriptive titles such as "Addresses issue #348". If your pull | ||
| request addresses an issue, please use the pull request title to describe | ||
| the issue and mention the issue number in the pull request description. | ||
| - The description should provide at least 1-2 sentences describing the pull request | ||
| in detail (Why is this change required? What problem does it solve?) and | ||
| link to any relevant issues. If modifying a plot, render your plot to inspect for changes | ||
| and copy image in the pull request message on Github | ||
| - Please prefix the title of incomplete contributions with [WIP] (to indicate a work in | ||
| progress). WIPs may be useful to (1) indicate you are working on something to avoid | ||
| duplicated work, (2) request broad review of functionality or API, or (3) seek collaborators. | ||
| --> | ||
|
|
||
|
|
||
| ## Checklist | ||
| <!-- Feel free to remove check-list items aren't relevant to your change --> | ||
|
|
||
| - [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) | ||
| PR format? | ||
| - [ ] Does the PR include new or updated tests to prevent issue recurrence (using [pytest fixture pattern]( | ||
| https://docs.pytest.org/en/latest/fixture.html#fixture))? | ||
| - [ ] Is your code style correct (follows pylint and black guidelines)? | ||
| - [ ] Is the fix listed in the [Maintenance and fixes](https://github.com/arviz-devs/arviz/blob/master/CHANGELOG.md#maintenance-and-fixes) | ||
| section of the changelog? | ||
|
|
||
| <!-- | ||
| Also, please consider reading the contributing guidelines and code of conduct carefully before submitting the PR. They are available at | ||
| - https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md | ||
| - https://github.com/arviz-devs/arviz/blob/master/CODE_OF_CONDUCT.md | ||
| We understand that PRs can sometimes be overwhelming, especially as the | ||
| reviews start coming in. Please let us know if the reviews are unclear or | ||
| the recommended next step seems overly demanding, if you would like help in | ||
| addressing a reviewer's comments, or if you have been waiting too long to hear | ||
| back on your PR. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| ## Description | ||
| <!-- | ||
| Thank you so much for your PR! To help us review your contribution, please | ||
| consider the following points: | ||
| - The PR title should summarize the changes, for example "Add new group argument for the | ||
| pair plot". Avoid non-descriptive titles such as "Addresses issue #348". If your pull | ||
| request addresses an issue, please use the pull request title to describe | ||
| the issue and mention the issue number in the pull request description. | ||
| - The description should provide at least 1-2 sentences describing the pull request | ||
| in detail (Why is this change required? What problem does it solve?) and | ||
| link to any relevant issues. If modifying a plot, render your plot to inspect for changes | ||
| and copy image in the pull request message on Github | ||
| - Please prefix the title of incomplete contributions with [WIP] (to indicate a work in | ||
| progress). WIPs may be useful to (1) indicate you are working on something to avoid | ||
| duplicated work, (2) request broad review of functionality or API, or (3) seek collaborators. | ||
| --> | ||
|
|
||
| ## Checklist | ||
| <!-- Feel free to remove check-list items aren't relevant to your change --> | ||
|
|
||
| - [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) | ||
| PR format? | ||
| - [ ] Is the documentation [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant? | ||
| - [ ] Is the fix listed in the [Documentation](https://github.com/arviz-devs/arviz/blob/master/CHANGELOG.md#documentation) | ||
| section of the changelog? | ||
|
|
||
| <!-- | ||
| Also, please consider reading the contributing guidelines and code of conduct carefully before submitting the PR. They are available at | ||
| - https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md | ||
| - https://github.com/arviz-devs/arviz/blob/master/CODE_OF_CONDUCT.md | ||
| - If you are contributing fixes to docstrings, please pay attention to | ||
| https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#docstring-formatting. | ||
| In particular, note the difference between using single backquotes, double backquotes, and | ||
| asterisks in the markup. | ||
| We understand that PRs can sometimes be overwhelming, especially as the | ||
| reviews start coming in. Please let us know if the reviews are unclear or | ||
| the recommended next step seems overly demanding, if you would like help in | ||
| addressing a reviewer's comments, or if you have been waiting too long to hear | ||
| back on your PR. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| ## Description | ||
| <!-- | ||
| Thank you so much for your PR! To help us review your contribution, please | ||
| consider the following points: | ||
| - The PR title should summarize the changes, for example "Add new group argument for the | ||
| pair plot". Avoid non-descriptive titles such as "Addresses issue #348". If your pull | ||
| request addresses an issue, please use the pull request title to describe | ||
| the issue and mention the issue number in the pull request description. | ||
| - The description should provide at least 1-2 sentences describing the pull request | ||
| in detail (Why is this change required? What problem does it solve?) and | ||
| link to any relevant issues. If modifying a plot, render your plot to inspect for changes | ||
| and copy image in the pull request message on Github | ||
| - Please prefix the title of incomplete contributions with [WIP] (to indicate a work in | ||
| progress). WIPs may be useful to (1) indicate you are working on something to avoid | ||
| duplicated work, (2) request broad review of functionality or API, or (3) seek collaborators. | ||
| --> | ||
|
|
||
|
|
||
| ## Checklist | ||
| <!-- Feel free to remove check-list items aren't relevant to your change --> | ||
|
|
||
| - [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#pull-request-checklist) | ||
| PR format? | ||
| - [ ] Has included a sample plot to visually illustrate the changes? (only for plot-related functions) | ||
| - [ ] Is the new feature properly documented with an example? | ||
| - [ ] Does the PR include new or updated tests to cover the new feature (using [pytest fixture pattern]( | ||
| https://docs.pytest.org/en/latest/fixture.html#fixture))? | ||
| - [ ] Is your code style correct (follows pylint and black guidelines)? | ||
| - [ ] Is the new feature listed in the [New features](https://github.com/arviz-devs/arviz/blob/master/CHANGELOG.md#new-features) | ||
| section of the changelog? | ||
|
|
||
| <!-- | ||
| Also, please consider reading the contributing guidelines and code of conduct carefully before submitting the PR. They are available at | ||
| - https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md | ||
| - https://github.com/arviz-devs/arviz/blob/master/CODE_OF_CONDUCT.md | ||
| - If you are contributing fixes to docstrings, please pay attention to | ||
| https://github.com/arviz-devs/arviz/blob/master/CONTRIBUTING.md#docstring-formatting. | ||
| In particular, note the difference between using single backquotes, double backquotes, and | ||
| asterisks in the markup. | ||
| We understand that PRs can sometimes be overwhelming, especially as the | ||
| reviews start coming in. Please let us know if the reviews are unclear or | ||
| the recommended next step seems overly demanding, if you would like help in | ||
| addressing a reviewer's comments, or if you have been waiting too long to hear | ||
| back on your PR. | ||
| --> |