|
1 | 1 | # CMI-DAIR Template Python Repository |
2 | 2 |
|
3 | | -This is a template repository. Below is a checklist of things you should do to use it: |
| 3 | +Welcome to the CMI-DAIR Template Python Repository! This template is designed to streamline your project setup and ensure a consistent structure. To get started, follow these steps: |
4 | 4 |
|
5 | | -- [ ] Run `setup_template.py` to set up the repository. |
6 | | -- [ ] Rewrite this `README` file. |
7 | | -- [ ] Install the `pre-commit` hooks. |
8 | | -- [ ] Update the `LICENSE` file to your desired license and set the year. |
9 | | -- [ ] Update the supported versions in `SECURITY.md` or, if not relevant, delete this file. |
| 5 | + |
| 6 | +- [ ] Run `setup_template.py` to initialize the repository. |
| 7 | +- [ ] Replace the content of this `README.md` with details specific to your project. |
| 8 | +- [ ] Install the `pre-commit` hooks to ensure code quality on each commit. |
| 9 | +- [ ] Revise SECURITY.md to reflect supported versions or remove it if not applicable. |
10 | 10 | - [ ] Remove the placeholder src and test files, these are there merely to show how the CI works. |
11 | | -- [ ] Grant third-party app permissions (e.g. Codecov) [here](https://github.com/organizations/cmi-dair/settings/installations), if necessary. |
12 | | -- [ ] Either generate a `CODECOV_TOKEN` secret [here](https://github.com/cmi-dair/flowdump/blob/main/.github/workflows/python_tests.yaml) (if its a private repository) or remove the line `token: ${{ secrets.CODECOV_TOKEN }}` |
13 | | -- [ ] API docs website: After the first successful build, go to the `Settings` tab of your repository, scroll down to the `GitHub Pages` section, and select `gh-pages` as the source. This will generate a link to your API docs. |
| 11 | +- [ ] If it hasn't already been done for your organization/acccount, grant third-party app permissions for CodeCov. |
| 12 | +- [ ] To set up an API documentation website, after the first successful build, go to the `Settings` tab of your repository, scroll down to the `GitHub Pages` section, and select `gh-pages` as the source. This will generate a link to your API docs. |
14 | 13 | - [ ] Update stability badge in `README.md` to reflect the current state of the project. A list of stability badges to copy can be found [here](https://github.com/orangemug/stability-badges). The [node documentation](https://nodejs.org/docs/latest-v20.x/api/documentation.html#documentation_stability_index) can be used as a reference for the stability levels. |
15 | 14 |
|
16 | 15 | # Project name |
|
0 commit comments