Skip to content

Commit 74d35d2

Browse files
Updated docs to reflect newest additions of tests and linters
Signed-off-by: Natalia Luzuriaga <natalia.luzuriaga@cms.hhs.gov>
1 parent 7f10eab commit 74d35d2

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
5757

5858
### Testing Conventions
5959

60-
<!--- TODO: Currently, does not have tests. Write tests then discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has. -->
60+
We use `pytest-cookies` to ensure projects are generated successfully using our repository templates via cookiecutter. Tests are located in the `tests` directory and are run on each pull request in `test.yml`.
6161

62-
### Coding Style and Linters
62+
To run tests: `pytest --template $TIER_DIRECTORY`
6363

64-
<!-- TODO - Add the repo's linting and code style guidelines -->
64+
### Coding Style and Linters
6565

66-
Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
66+
On each pull request, `ci-docs.yml` runs MarkdownLinkCheck to lint markdown files.
6767

6868
### Writing Issues
6969

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,7 @@ for more information.
232232

233233
## Coding Style and Linters
234234

235-
<!-- TODO - Add the repo's linting and code style guidelines -->
236-
237-
Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
235+
On each pull request, `ci-docs.yml` runs MarkdownLinkCheck to lint markdown files.
238236

239237
## Branching Model
240238

0 commit comments

Comments
 (0)