We want to make contributing to this project as easy and transparent as possible.
The hope is that Reindeer will be useful to people throughout the Rust community. However, since we've developed it as internal project to serve internal goals, its unlikely to meet anyone else's requirements immediately, so we'd like to see issues and PRs to add those features.
Reindeer's primary repository is mainained internally at Facebook, which is periodically synced with github. Code changes are first merged with the internal version and republished.
We actively welcome your pull requests.
- 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.
Reindeer follows conventional Rust coding style, with a provided .rustfmt.toml for formatting.
By contributing to Reindeer, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.