OVVE is primarily developed by `https://lifemech.org/`_, but we welcome contributions.
OVVE tracks many issues internally, but we use github's issue tracker for public facing issues. Feel free to browse the issues there and tackle any you feel equipped to do. When you update or add comments to an issue.
You should ensure the following are true for any PR before it will be considered for review or re-review
- The code and architecture comply with Standards and Best Practices
- Any UI components comply with the project `Style Guide`_
- Contributions follow any subsystem specific practices (example: `Javascript Guide`_)
- Automated regression and integration tests are passing
- Any automated feedback (label bot, lint bot, etc) is addressed
- Any previous developer feedback is addressed
Before submitting a PR, review our Guide to Authoring Pull Requests. if you have questions or need feedback do write to xyz@lifemech.org
To file a bug report, please follow the system outlined in our bug reports wiki page. You are also welcome to submit an accompanying pull request if you are able to resolve the issue.
Technical documentation is available at Read the Docs. It is written in reStructuredText.
The User Configurable Reporting documentation also shows another good practice; it uses reStructuredText's autoclass directive to include the documentation written as docstrings in the codebase. This avoids duplication, and means that when the codebase is changed, the documentation is updated automatically with it.
Add a file to the docs/ directory, and a reference to it in
docs/index.rst under the toctree directive, to include it with the
rest of OVVE documentation.
To update requirements edit:
requirements.txtfor packages for all environments
PRs that are not ready to be merged can be labeled with one of the following labels:
- awaiting QA
- Open for review: do not merge
As long as either of these labels are present on the PR it will have a pending status.