We want to make contributing to this project as easy and transparent as possible, and actively welcome your pull requests. If you run into problems, please open an issue on GitHub.
- 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.
- 2 spaces for indentation rather than tabs
If you need a different version of one of the testing dependencies, you will need to first install carthage:
brew install carthage
Then, edit Cartfile.private to specify the version of the dependency you'd like to use.
Finally, run
carthage update --use-submodules --platform iOS
to update the dependency to that version.
By contributing to ComponentKit, you agree that your contributions will be licensed under its BSD license.