First of all: thanks for considering contributing to this project!
Here are the steps required for contributing:
-
Make sure your branch is up to date with the current master
-
Install latest dependencies with
yarn
-
Develop your feature/bug fix
-
Create tests for as much as possible
-
Make sure eslint errors are fixed, if eslint errors don't show up in your editor you can always check them with
npm run eslint
-
Check if everything works well by using the example application
-
Create a build for the translation manager
npm run build
-
Create a build for the example application
cd example
npm run build
-
Run the translation manager
npm run manage:translations
-
Commit your changes according to the conventional changelog commit convention we use
-
Create a pull request
(If you encounter additional steps during your contribution, do not hesitate to update this document)