We want to make contributing to this project as easy and transparent as possible.
First, note that there is now a PyTorch version fairseq-py of this toolkit and new development efforts will focus on it. That being said, we actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- 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.
- 4 spaces for indentation rather than tabs
- 80 character line length
- CamelCase; capitalized class names and lower-case function names
By contributing to fairseq, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.