edx-repo-health contains static checks on repo structures. The checks are meant to work in conjunction withpytest-repo-health plugin.
The checks see if a given repository follows minimum standards. Each check is meant to be minimum and only check for simple specific things. This is to make it easier to debug changes. No asserts should be placed inside of the checks. All necessary data about compliance and deviations should be placed in all_results dictionary. (implemented though pytest fixture)
Check pytest-repo-health for more info on check design.
- Documenting standard reqs/checks in each check better
- create tests for the checks and make sure they behave correctly to diff dir/file structure.
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
The code in this repository is licensed under the Apache Software License 2.0 unless otherwise noted.
Please see LICENSE.txt for details.
Please do not report security issues in public. Please email [email protected].
Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.