We welcome all contributions. Read further to know the details.
Information about bugs, possible improvements and desired features are always welcome.
You do not need to write the code. Just let us know what issue you found and we will be happy to work on it.
Create an issue or a pull request. For other inquiries, please contact us via email info@automat.berlin.
We use ESLint and Prettier together with husky and lint-staged to enforce styling rules we agreed on.
The role of the tools mentioned above is:
- husky - to set up a pre-commit hook
- lint-staged - to run commands against files to be commited
- prettier - to format the code
- eslint - to lint the code
Thanks to these tools when you try to make a commit, your code style will be automatically verified.
Your commit will fail if verification fails. You should get information about issues in your code.
Try to run following commands to automatically solve the issues:
$ npm run format
$ npm run lint
If all issues are solved, you are ready to commit your code.
Note that some issues may not be solved automatically and require to be manually solved.
Add type prefix to commit subject as described here: https://seesparkbox.com/foundry/semantic_commit_messages.
Use the imperative, present tense (e.g. "change" not "changed" nor "changes").
Check commit history to see examples.