We want to make contributing to this project as easy and transparent as possible.
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: https://code.facebook.com/cla
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 testing framework and testing data that needs to be downloaded, please make sure that test are passing:
pytest
We use mypy to check Python typing and guard API consistency, please make sure next command doesn't complain prior to submission:
mypy . --ignore-missing-imports
We use black to format our code, you can use the following commands to format your code prior to submission:
pip install black
black habitat test --line-length 79
By contributing to habitat-api, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.