We want to make contributing to this project as easy and transparent as possible.
Coming soon.
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.
Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
We use the Black code formatter for all Python files. You can install the latest release via pip install black and run it over the library via black ax.
The Ax website was created with Docusaurus. FontAwesome icons were used under the Creative Commons Attribution 4.0 International.
You will need Node >= 8.x and Yarn >= 1.5 to build the Sphinx docs and Docusaurus site (which embeds the Sphinx docs inside). The following command will both build the docs and serve the site locally:
cd scripts
./make_docs.sh
Open http://localhost:3000 (if doesn't automatically open).
Anytime you change the contents of the page, the page should auto-update.
The site is hosted as a GitHub page. Once Ax is live, we will generate a static
site and automatically push the output to the gh-pages branch via CircleCI.
By contributing to Ax, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.