5075f5c5d8
Some checks are pending
Automatisch Backend Tests / test (push) Waiting to run
Automatisch CI / linter (push) Waiting to run
Automatisch CI / start-backend-server (push) Waiting to run
Automatisch CI / start-backend-worker (push) Waiting to run
Automatisch CI / build-web (push) Waiting to run
Automatisch UI Tests / test (push) Waiting to run
26 lines
1.2 KiB
Markdown
26 lines
1.2 KiB
Markdown
# Contribution Guide
|
|
|
|
We are happy that you want to contribute to Automatisch. We will assist you in the contribution process. This guide will help you to get started.
|
|
|
|
## We develop with GitHub
|
|
|
|
We use GitHub to host code, track issues, and feature requests, as well as accept pull requests. You can follow those steps to contribute to the project:
|
|
|
|
1. Fork the repository and create your branch from the `main`.
|
|
2. Create your feature branch (`git checkout -b feature/feature-description`)
|
|
3. If you've added code that should be documented, update the documentation.
|
|
4. Make sure to use the linter by running `yarn lint` command in the project root folder.
|
|
5. Create a pull request!
|
|
|
|
## Use conventional commit messages
|
|
|
|
We use [conventional commit messages](https://www.conventionalcommits.org) to generate changelogs and release notes. Therefore, please follow the guidelines when writing commit messages.
|
|
|
|
## Report bugs using GitHub issues
|
|
|
|
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/automatisch/automatisch/issues/new).
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the AGPL-3.0 license.
|