-
-
Notifications
You must be signed in to change notification settings - Fork 589
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Simplify PR template * Minor adjustment
- Loading branch information
Showing
1 changed file
with
9 additions
and
17 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 |
|---|---|---|
| @@ -1,26 +1,18 @@ | ||
| # Description | ||
|
|
||
| Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
| Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. | ||
|
|
||
| Fixes # (issue) | ||
|
|
||
| ## Type of change | ||
|
|
||
| Please add a line in the relevant section of [CHANGELOG.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CHANGELOG.md) to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes. | ||
| Please add a line in the relevant section of [CHANGELOG.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CHANGELOG.md) to document the change (include PR #) | ||
|
|
||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Optimization (back-end change that speeds up the code) | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| # Important checks: | ||
|
|
||
| # Key checklist: | ||
|
|
||
| - [ ] No style issues: `$ pre-commit run` (or `$ nox -s pre-commit`) (see [CONTRIBUTING.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md#installing-and-using-pre-commit) for how to set this up to run automatically when committing locally, in just two lines of code) | ||
| - [ ] All tests pass: `$ python -m pytest` (or `$ nox -s tests`) | ||
| - [ ] The documentation builds: `$ python -m pytest --doctest-plus src` (or `$ nox -s doctests`) | ||
|
|
||
| You can run integration tests, unit tests, and doctests together at once, using `$ nox -s quick`. | ||
|
|
||
| ## Further checks: | ||
|
|
||
| - [ ] Code is commented, particularly in hard-to-understand areas | ||
| - [ ] Tests added that prove fix is effective or that feature works | ||
| Please confirm the following before marking the PR as ready for review: | ||
| - No style issues: `nox -s pre-commit` | ||
| - All tests pass: `nox -s tests` | ||
| - The documentation builds: `nox -s doctests` | ||
| - Code is commented for hard-to-understand areas | ||
| - Tests added that prove fix is effective or that feature works |