We want to make contributing to this project as easy and transparent as possible.
We actively welcome your pull requests. We check commits to the repository using CircleCI, which runs linters and Python tests.
- 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.
Linters and formatters we use include black, flake8, and mypy. Please include
type annotations in your code where reasonable. We only run mypy on the fastmri
directory. The fastmri_examples, fastmri, and tests directories are checked with
both black and flake8.
Configurations for the linters are in the root directory, .flake8 for flake8 and
mypy.ini for mypy. We use default configurations for black.
If all of the following commands pass without modifications or failures, your code should be ready for CircleCI:
black fastmri_examples fastmri tests
mypy fastmri
flake8 fastmri_examples fastmri testsBy contributing to fastMRI, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.