Contributing to This Project¶
We want to make contributing to this project as easy and transparent as possible.
Pull Requests¶
We actively welcome your pull requests.
Fork the repo and create your branch from
master.If you’ve added code that should be tested, add tests.
If you’ve changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.
Run Test Locally¶
Before submitting a pull request, please make sure the test suite passes.
You may need to modify or add new test cases in test/.
To install the test dependencies, run pip install "openbox[test]" or pip install -r requirements/dev/test.txt.
To run test locally:
pytest -rap test
To see output of each test case:
pytest -rap --durations=20 --verbose --capture=tee-sys test
Issues¶
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
We provide beginner-friendly issue templates to help you get started. Try filling an issue!
License¶
By contributing to this project, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.