Skip to content

Commit

Permalink
Add details about pre-commit to docs
Browse files Browse the repository at this point in the history
Included a note in the Installing section of README, and explicitly mentioned
pre-commit in the "follow the guidelines" bullet of the PR template
  • Loading branch information
mnlevy1981 committed May 25, 2024
1 parent aa6a747 commit f6a9750
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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?

<!-- You can erase any parts of this template not applicable to your Pull Request. -->
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit f6a9750

Please sign in to comment.