Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffjennings authored Jun 25, 2024
1 parent 62f5abe commit 851919e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is a basic template for a Python repository, with the components needed to
In more depth, the file structure is:
- `.github` has two subfolders:
* `ISSUE_TEMPLATE` has files that are templates users can select from when opening an issue in the repo on GitHub
* `workflows` implements continuous integration (CI) through GitHub action files that are automatically run according to a chosen trigger. These are currently:
* `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently:
1) `docs.yml` builds and deploys the [documentation site](https://cca-software-group.github.io/py_template/index.html) when a push is made to `main`.
2) `format_lint.yml` lints and formats the code on each push using `ruff` and `black`.
3) `tests.yml` runs tests with `pytest` on each push.
Expand Down

0 comments on commit 851919e

Please sign in to comment.