diff --git a/ADOPTERS.md b/ADOPTERS.md new file mode 100644 index 0000000..657767d --- /dev/null +++ b/ADOPTERS.md @@ -0,0 +1,7 @@ +# Adopters + +This is an alphabetical list of people and organizations who are using this +project. If you'd like to be included here, please send a Pull Request that +adds your information to this file. + +- [Pinterest](https://www.pinterest.com/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f4745bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +First off, thanks for taking the time to contribute! This guide will answer +some common questions about how this project works. + +While this is a Pinterest open source project, we welcome contributions from +everyone. Regular outside contributors can become project maintainers. + +## Making Changes + +1. Fork this repository to your own account +2. Make your changes and verify that tests pass +3. Commit your work and push to a new branch on your fork +4. Submit a pull request +5. Participate in the code review process by responding to feedback + +Once there is agreement that the code is in good shape, one of the project's +maintainers will merge your contribution. + +To increase the chances that your pull request will be accepted: + +- Follow the existing coding style +- Write a good commit message + +## License + +By contributing to this project, you agree that your contributions will be +licensed under its [Apache 2 license](LICENSE).