1*5be3f65cSAndroid Build Coastguard Worker# Contributing to ktfmt 2*5be3f65cSAndroid Build Coastguard WorkerWe want to make contributing to this project as easy and transparent as 3*5be3f65cSAndroid Build Coastguard Workerpossible. 4*5be3f65cSAndroid Build Coastguard Worker 5*5be3f65cSAndroid Build Coastguard Worker**If you plan a significant change, please first start a discussion as a GitHub Issue.** 6*5be3f65cSAndroid Build Coastguard Worker 7*5be3f65cSAndroid Build Coastguard Worker## Pull Requests 8*5be3f65cSAndroid Build Coastguard WorkerWe actively welcome your pull requests. 9*5be3f65cSAndroid Build Coastguard Worker 10*5be3f65cSAndroid Build Coastguard Worker1. Fork the repo and create your branch from `main`. 11*5be3f65cSAndroid Build Coastguard Worker2. If you've added code that should be tested, add tests. 12*5be3f65cSAndroid Build Coastguard Worker3. If you've changed APIs, update the documentation. 13*5be3f65cSAndroid Build Coastguard Worker4. Ensure the test suite passes. 14*5be3f65cSAndroid Build Coastguard Worker5. Make sure your code lints. 15*5be3f65cSAndroid Build Coastguard Worker6. If you haven't already, complete the Contributor License Agreement ("CLA"). 16*5be3f65cSAndroid Build Coastguard Worker7. If applicable add relevant change information to the changelog 17*5be3f65cSAndroid Build Coastguard Worker 18*5be3f65cSAndroid Build Coastguard WorkerNote that pull requests are imported into Facebook's internal repository and code is 19*5be3f65cSAndroid Build Coastguard Workerformatted as part of that process (using ktfmt!). It's not necessary for PRs to stick 20*5be3f65cSAndroid Build Coastguard Workerto the existing style of this repository, though that does make code reviews easier. 21*5be3f65cSAndroid Build Coastguard Worker 22*5be3f65cSAndroid Build Coastguard Worker## Contributor License Agreement ("CLA") 23*5be3f65cSAndroid Build Coastguard WorkerIn order to accept your pull request, we need you to submit a CLA. You only need 24*5be3f65cSAndroid Build Coastguard Workerto do this once to work on any of Facebook's open source projects. 25*5be3f65cSAndroid Build Coastguard Worker 26*5be3f65cSAndroid Build Coastguard WorkerComplete your CLA here: <https://code.facebook.com/cla> 27*5be3f65cSAndroid Build Coastguard Worker 28*5be3f65cSAndroid Build Coastguard Worker## Issues 29*5be3f65cSAndroid Build Coastguard WorkerWe use GitHub issues to track public bugs. Please ensure your description is 30*5be3f65cSAndroid Build Coastguard Workerclear and has sufficient instructions to be able to reproduce the issue. 31*5be3f65cSAndroid Build Coastguard Worker 32*5be3f65cSAndroid Build Coastguard WorkerFacebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe 33*5be3f65cSAndroid Build Coastguard Workerdisclosure of security bugs. In those cases, please go through the process 34*5be3f65cSAndroid Build Coastguard Workeroutlined on that page and do not file a public issue. 35*5be3f65cSAndroid Build Coastguard Worker 36*5be3f65cSAndroid Build Coastguard Worker## License 37*5be3f65cSAndroid Build Coastguard WorkerBy contributing to ktfmt, you agree that your contributions will be licensed 38*5be3f65cSAndroid Build Coastguard Workerunder the LICENSE file in the root directory of this source tree. 39