Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.63 KB
Raw

Contributing to fvcore

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Testing

Please follow the instructions mentioned in test-README to run the existing and your newly added tests.

Linting

We provide a linting script to correctly format your code changes. Please follow the instructions mentioned in dev-README to run the linter.

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

Issues

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.

License

By contributing to fvcore, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.