The following is a set of guidelines for contributing to ERT.
- We use Black code formatting
- All code must be testable and unit tested.
- Commit messages should follow the format as described here https://chris.beams.io/posts/git-commit/
- Work on your own fork of the main repo
- Push your commits and make a draft pull request using the pull request template.
- Check that your pull request passes all tests.
- When all tests have passed and your are happy with your changes, change your pull request to "ready for review" and ask for a code review.
- When your code has been approved—rebase, squash and merge your changes.
You can build the documentation after installation by running
pip install -r dev-requirements.txt
sphinx-build -n -v -E -W ./docs/rst/manual ./tmp/ert_docsand then open the generated ./tmp/ert_docs/index.html in a browser.