DOC: Adding testing guidelines for RocketPy - Githubissues

RocketPy-Team / RocketPy

Next generation High-Power Rocketry 6-DOF Trajectory Simulation

https://docs.rocketpy.org/

MIT License

570 stars 137 forks source link

DOC: Adding testing guidelines for RocketPy #626

Closed lucasfourier closed 1 day ago

lucasfourier commented 6 days ago

Pull request type

[ ] Code changes (bugfix, features)
[ ] Code maintenance (refactoring, formatting, tests)
[X] ReadMe, Docs and GitHub updates
[ ] Other (please describe):

Checklist

[ ] Tests for the changes have been added (if needed)
[X] Docs have been reviewed and added / updated
[ ] Lint (black rocketpy/ tests/) has passed locally
[ ] All tests (pytest tests -m slow --runslow) have passed locally
[ ] CHANGELOG.md has been updated (if relevant)

Current behavior

Currently, RocketPy docs does not formally define guidelines for contributions regarding tests.

New behavior

From now on, RocketPy will have formal guidelines for developers seeking to contribute for the test suite.

Breaking change

[ ] Yes
[X] No

Additional information

New part of the docs: