Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.05 KB
Raw

Contributing

Contributions are very welcome. The following will provide some helpful guidelines.

Getting started

Create a clone of the project and navigate into the directory.

Install all dependencies

npm i

Build the project

npm run build

Run tests

npm run test

Format the code

npm run format

How to contribute

If you want to submit a contribution, please follow the following workflow:

  • Fork the project
  • Create a feature branch
  • Add your contribution
  • Make sure that the project successfully builds and all tests are green
  • Please format your code
  • Create a Pull Request

Commits

Commit messages should be clear and fully elaborate the context and the reason of a change. If your commit refers to an issue, please post-fix it with the issue number, e.g.

Issue: #123

Furthermore, commits should be signed off according to the DCO.

Pull Requests

If your Pull Request resolves an issue, please add a respective line to the end, like

Resolves #123