CONTRIBUTING.md

mittwald API toolset -- Contribution guide

General considerations

• We enforce a uniform coding style across this project. Please make sure to run yarn format before committing your changes.
• Nearly all files in the @mittwald/api-client package are generated from the OpenAPI spec. Please do not edit these files manually. Instead, edit the corresponding template files in the packages/generator/resources/templates directory.

Use Conventional Commits

Please use the Conventional Commits syntax for your commit messages. It is required because the CI automatically determines the version bump and generates CHANGELOG.md files based on the included commits when a PR is merged.

Building locally

Requirements for building the project locally:

• Node.JS
• Yarn

To build the project locally, run the following commands:

$ yarn install
$ yarn compile

To run the test suite, run the following command:

$ yarn test