We want to make contributing to this project as easy and transparent as possible.
The version of Lexical iOS you see in this repo is the same as the version we are using internally at Meta. While our internal repository is considered the 'source of truth', it is synced automatically with this GitHub repo. (Note that this is the opposite way round to Lexical JavaScript, which uses the GitHub repo as source of truth.)
Any changes made by external contributors which change Lexical's existing behaviour or public APIs, please discuss your proposals with us first! We may need to delay merging your PR until we have chance to update and test our internal app integrations.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've added code that can be tested via unit tests, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- If you haven't already, complete the Contributor License Agreement ("CLA").
We don't have a public SwiftLint configuration for this project yet, but once we do, contributions will be expected to run the linter.
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 Meta'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.
Meta 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
- Opening braces on same line
- No hard-fast line length limit, but be reasonable!
By contributing to Lexical iOS, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.