We want to make contributing to this project as easy and transparent as possible.
Just submit pull requests as is usual for git (thank you!). We won't pull the request directly though. Upon approval, we'll cherry-pick your changes internally while of course maintaining you as an author, and then we'll publish them to github. After all that, we'll close the pull request.
This somewhat roundabout process is motivated by our need to maintain an internal source of truth inside the larger context of our larger internal repository.
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://developers.facebook.com/opensource/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.
- 2 spaces for indentation rather than tabs
- 80 character line length
- For spacing around punctuation and similar minutia, follow the practices in the file(s) you're working on
By contributing to flint, you agree that your contributions will be licensed under its Boost license.