From aa6a7475fefa0512d68d8cd4d63ee01a707ca300 Mon Sep 17 00:00:00 2001 From: Michael Levy Date: Fri, 17 May 2024 16:37:02 -0600 Subject: [PATCH 1/3] Add pre-commit to cupid-dev --- environments/dev-environment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/environments/dev-environment.yml b/environments/dev-environment.yml index 632ba79..30aec30 100644 --- a/environments/dev-environment.yml +++ b/environments/dev-environment.yml @@ -12,6 +12,7 @@ dependencies: - nco - pandas - papermill + - pre-commit - pip - ploomber=0.22.3 - pyyaml From f6a9750c4f03fe7629e38cd8ef8ee06b8e8b02f7 Mon Sep 17 00:00:00 2001 From: Michael Levy Date: Sat, 25 May 2024 10:03:18 -0600 Subject: [PATCH 2/3] Add details about pre-commit to docs Included a note in the Installing section of README, and explicitly mentioned pre-commit in the "follow the guidelines" bullet of the PR template --- .../PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- README.md | 14 ++++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 4c1644e..b8e7067 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,6 +1,6 @@ ### All Submissions: -* [ ] Have you followed the guidelines in our Contributing document? +* [ ] Have you followed the guidelines in our Contributing document (including the `pre-commit` check)? * [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? diff --git a/README.md b/README.md index d60a4ce..de40497 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,16 @@ If you do not have `mamba` installed, you can still use `conda`... it will just 1. If `./manage_externals/checkout_externals` is not found, run `git submodule update --init` to clone the submodule. 1. If `which cupid-run` returned the error `which: no cupid-run in ($PATH)`, then please run the following: -``` bash -$ conda activate cupid-dev -$ pip install -e . # installs cupid -``` + ``` bash + $ conda activate cupid-dev + $ pip install -e . # installs cupid + ``` + +1. If you plan on contributing code to CUPiD, +whether developing CUPiD itself or providing notebooks for CUPiD to run, +please see the [Contributer's Guide](https://github.com/NCAR/CUPiD/wiki/Contributor's-Guide). +Note that CUPiD uses `pre-commit` to ensure code formatting guidelines are followed, +and pull requests will not be accepted if they fail the `pre-commit`-based Github Action. ## Running From 1c96e6b9ace0b9b37c5859ca46896aae4df3f07a Mon Sep 17 00:00:00 2001 From: Teagan King <98482480+TeaganKing@users.noreply.github.com> Date: Sun, 26 May 2024 08:18:05 -0600 Subject: [PATCH 3/3] Add contributor's guide link --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index b8e7067..3b00376 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,6 +1,6 @@ ### All Submissions: -* [ ] Have you followed the guidelines in our Contributing document (including the `pre-commit` check)? +* [ ] Have you followed the guidelines in our Contributer's Guide](https://github.com/NCAR/CUPiD/wiki/Contributor's-Guide) (including the `pre-commit` check)? * [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?