category: framework-contributing
CKEditor 5 is an Open Source project and we will be most thankful for your contributions. You can help us by fixing issues, reporting them or translating the editor interface. Community effort and engagement is what has been driving the development of our WYSIWYG editor projects since 2003!
Before you start, here are some things to keep in mind:
To learn how to set up the project and run tests see the {@link framework/guides/contributing/development-environment development environment} guide.
Read more in the code style, naming and file naming guidelines.
Every package repository installs Git hooks that automatically lint 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% 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 the testing phase (before a release) to make sure no regressions were created.
Read more about our {@link framework/guides/contributing/testing-environment testing environment}.
GitHub provides an [excellent documentation about pull requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/). If you are not sure what to do, this is the right place to start.
[Angular](https://github.com/ckeditor/ckeditor5-angular), [React](https://github.com/ckeditor/ckeditor5-react) and [Vue](https://github.com/ckeditor/ckeditor5-vue) integrations as well as [CKEditor 5 inspector](https://github.com/ckeditor/ckeditor5-inspector) and [dev packages](https://github.com/ckeditor/ckeditor5-dev) are kept in separate repositories. The below steps assume that you want to propose a change in the [main CKEditor 5 repository](https://github.com/ckeditor/ckeditor5).
Assuming that you would like to propose some changes, these are the steps you should take to create a pull request:
https://github.com/YOUR-USERNAME/ckeditor5.Open your terminal, then go to the package ("repository") folder in your development environment:
$ cd path/to/ckeditor5
Start a new branch for your code. We use the i/GITHUB-ISSUE-NUMBER convention for branch names:
$ git checkout -b i/GITHUB-ISSUE-NUMBER
Make the changes. Stick to the code-style guidelines and remember about tests and 100% code coverage!
Commit your changes:
$ git commit -m "Squashed a nasty bug in the link editing."
Now it is time to make your changes public. First, you need to let git know about the fork you created by adding the remote:
$ git remote add my-fork https://github.com/YOUR-USERNAME/ckeditor5
Push your changes to your forked repository:
$ git push my-fork i/GITHUB-ISSUE-NUMBER
Go to your forked repository on GitHub. Use the pull request button and follow the instructions. Make sure to include a merge commit message text matches the {@link framework/guides/contributing/git-commit-message-convention convention}
Let us know about your pull request! The best way is to comment under the original issue.
Some additional things you should keep in mind:
CKEditor 5 is a project with global impact, so 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 below).
Read the {@link framework/guides/support/reporting-issues reporting issues} guide to learn more.
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 get more information, please follow this link: https://cla.ckeditor.com/.