Skip to content
This repository has been archived by the owner on Jan 1, 2024. It is now read-only.

Latest commit

 

History

History
49 lines (31 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 1.76 KB

Contributing to GAD

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

Pull Requests

Every pull request should have a description that motivates it and should have tests that cover all of the source lines touched and added by the request.

No pull request will be merged unless all tests are passing.

The person approving a pull request will also merge it into main.

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

We rely on cargo fmt and cargo clippy to ensure consistent formatting and enforce common style rules.

A TODO comment should include the number of an issue that describes the outstanding work in greater detail.

New public APIs should be documented.

Additional guidelines may be found in the Rust style guide and in the Rust API guidelines.

License

By contributing to GAD, you agree that your contributions will be licensed under the LICENSE-MIT and LICENSE-APACHE files in the root directory of this source tree.