Things to keep in mind:
To learn how to set up the project and run tests see the development environment guide.
Read more in code style, naming and file naming guidelines.
Every package repository installs git hooks which automatically lints and check the code for code style on commit. However, not every code style issue can be discovered this way, so please do not rely on tools too much :).
We maintain a 100% of code coverage (including code branches) and pull requests with missing tests will not be accepted. However, keep in mind that 100% is not everything – every change must be tested. This means that if you are fixing a bug and your patch did not change the code coverage, the change itself needs a test anyway.
Besides automated tests, you may be asked to create a manual test for the issue. Such manual tests let us quickly validate that the issue was really fixed and are later used during a testing phase (before a release) to make sure no regressions were created.
Read more about our testing environment.
GitHub provides an extensive documentation about pull requests, so we will skip that.
The only additional things you need to remember is to:
t/<ticket name> convention for branch names).Being this a project with global impact, contributing translations is both an easy and powerful way to help.
We use the Transifex service for translations at the following address: https://www.transifex.com/ckeditor/ckeditor5/dashboard/.
Here as well, having a CLA in place is a requirement to become an official translator (see bellow).
Each repository independently handles its issues. However, it's recommended to report issues in the main repository unless you know to which specific repository the issue belongs.
Things to keep in mind:
The issues pages can be used for feature requests.
To accept contributions sent to us in form of code, documentation or translations, a Contributor License Agreement (CLA) must be in place in order to clarify the intellectual property license granted with them. This license is for your protection as a contributor as well as the protection of us and our users; it does not change your rights to use your own contributions for any other purpose.
To sign the CLA and to have more information, please follow this link: http://cla.ckeditor.com/.