Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 1.55 KB
Raw

Contributing to Mariana Trench

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 (please see the following section).
  5. Make sure your code lints (please see the following section).
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

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. If you have any questions, please drop us a line at [email protected].

You are also expected to follow the Code of Conduct, so please read that if you are a new contributor.

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.

Coding Style

We value consistent code. Please follow the style of the surrounding code. Useful rules of thumb for all languages are

  • avoid abbreviations.
  • use autoformatters to minimize debates about spacing, indentation and line breaks.

License

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