Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

Latest commit

 

History

History
40 lines (27 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.55 KB
Raw

Contributing to CC-Net

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 master.
  2. Install dev dependencies with pip install -e .[dev].
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes pytest tests
  6. Make sure your code lints isort -rc && black . && mypy --ignore-missing-imports .
  7. If you haven't already, complete the Contributor License Agreement ("CLA").
  8. make test runs an end-to-end test. Run it once from scratch (by removing test_data/) if you have changed the mining.

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.

Coding Style

  • Formatting is done by Black

License

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