docs/standard/contributing: Add Github Actions tests notes #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
commented
Dec 16, 2022
|
|
||
| Tests are written using the [pytest framework](https://docs.pytest.org/en/7.2.x/) and use methods from [JSON Schema and CSV Codelists](https://jscc.readthedocs.io/en/latest/). | ||
|
|
||
| There are two test files: |
Author
There was a problem hiding this comment.
This is out of date - there are 3 now. test_examples_json.py is new.
I'd suggest a better approach is to point to the the tests directory on GitHub and we'll make sure there are docstrings/comments there.
There was a problem hiding this comment.
Can a string be added a the top of each file with a summary of what the tests cover (like the bullet points below)?
Based on experience from OCDS, we can't expect analysts to be able to read a Python file and understand what is tested so we should provide some higher-level documentation.
ghost
mentioned this pull request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.