Skip to content

Commit

Permalink
Added pull request template and updated documentation to point out gi…
Browse files Browse the repository at this point in the history
…t stage is needed for pre-commit to work.
  • Loading branch information
djspstfc committed Aug 13, 2024
1 parent ab54566 commit 04cb54a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### General:

* [ ] Have you followed the guidelines in our Contributing document?
* [ ] Have all checks, quality assurance steps and tests passed?

### Quality checks:

* [ ] Have you updates the **CHANGELOG.rst** file?
* [ ] Have you updated the `version` and `author` attributes (as appropriate) in the **pyproject.toml** file?

### Community standards:

* [ ] Have you followed [Semantic Versioning](https://semver.org)?
* [ ] Have you updated the **docstrings** and / or **documentation** files to reflect your change?

### What is the purpose of this change?

The purpose of this change is to...

### What does the change consist of?

This change consists of...
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ feel free to create one.

## Development environment

Begin by collecting the repo from github.
Begin by collecting the repo from [GitHub](https://github.com/ESGF/esgf-playground-utils).

To contribute, you should be using `poetry` as your python package
manager, see <https://python-poetry.org> for installation instructions.
Expand Down Expand Up @@ -54,6 +54,7 @@ You can also (and are encouraged to) run the `pre-commit hooks` manually
as often as you like with:

``` shell
foo@bar:~$ git stage -A
foo@bar:~$ poetry run pre-commit run -a
```

Expand Down

0 comments on commit 04cb54a

Please sign in to comment.