From 04cb54af51cb43f1a9b86e12cd81699d4ee3224a Mon Sep 17 00:00:00 2001 From: "david.poulter" Date: Tue, 13 Aug 2024 12:38:18 +0100 Subject: [PATCH] Added pull request template and updated documentation to point out git stage is needed for pre-commit to work. --- .github/pull_request_template.md | 22 ++++++++++++++++++++++ CONTRIBUTING.md | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..fdf5948 --- /dev/null +++ b/.github/pull_request_template.md @@ -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... \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae84c0d..dfc4bfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 for installation instructions. @@ -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 ```