We want to make contributing to this project as easy and transparent as possible.
Changes and improvements will be released on an ongoing basis.
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.
- If you haven't already, complete the Contributor License Agreement ("CLA").
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
Complete your CLA here.
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 use pytest as our unit testing framework, and all tests reside in the
test_qhoptim/ directory.
You may run tests by installing pytest and running the following from the root directory of this source tree:
$ pytest test_qhoptim/
We use the Black code style with 120 character line length.
You may autoformat your code by installing Black and running the following from the root directory of this source tree:
$ black .
In addition, you may run flake8 to catch many glaring code issues.
By contributing to qhoptim, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.