This guide aims to make it easier for you to start contributing to the modelix project.
We use a YouTrack instance hosted on issues.modelix.org to keep track of modelix issues. If you want to create a new issue, you can do so in the corresponding GitHub repository, and it will be automatically imported into YouTrack.
We use Semantic Versioning in
modelix.core (a further rollout to the other modelix repositories is planned for the future).
Therefore, commit messages follow Conventional Commits.
To install the hooks enforcing the convention, you need to run
npm install and
pre-commit install in your local repository.
Branch names should always be prefixed.
The prefix is determined by the type of changes that your branch provides like
Alternatively you can use
issue/ followed by the issue id as your branch name, e.g.