This guide will assist you in understanding the development workflow, setting up the development environment, and navigating the contribution process.
Prior to creating a Pull Request, ensure that your commits adhere to the commit conventions utilized in this repository.
We request that when you create a commit, adhere to the convention
category(scope or module): message
in your commit message, using one of
the provided categories:
feat / feature
: all changes that introduce completely new code or new
features
fix
: changes that fix a bug (ideally you will additionally reference an
issue if present)
refactor
: any code related change that is not a fix nor a feature
docs
: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
build
: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
test
: all changes regarding tests (adding new tests or changing existing
ones)
ci
: all changes regarding the configuration of continuous integration (i.e.
github actions, ci system)
chore
: all changes to the repository that do not fit into any of the above
categories
e.g. feat(website): add simple website hosting module
For a comprehensive specification, please refer to https://www.conventionalcommits.org/.
This guide will assist you in understanding the development workflow, setting up the development environment, and navigating the contribution process.
Prior to creating a Pull Request, ensure that your commits adhere to the commit conventions utilized in this repository.
We request that when you create a commit, adhere to the convention
category(scope or module): message
in your commit message, using one of
the provided categories:
feat / feature
: all changes that introduce completely new code or new
features
fix
: changes that fix a bug (ideally you will additionally reference an
issue if present)
refactor
: any code related change that is not a fix nor a feature
docs
: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
build
: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
test
: all changes regarding tests (adding new tests or changing existing
ones)
ci
: all changes regarding the configuration of continuous integration (i.e.
github actions, ci system)
chore
: all changes to the repository that do not fit into any of the above
categories
e.g. feat(website): add simple website hosting module
For a comprehensive specification, please refer to https://www.conventionalcommits.org/.