Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.13 KB
Raw

Contributing

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

Follow the Code of Conduct

Contributors must follow the Code of Conduct.

How to contribute

We love pull requests. Here is a quick guide:

  1. You need to have Node.JS installed
  2. Fork the repo (see https://help.github.com/articles/fork-a-repo).
  3. Create a new branch from master.
  4. Run npm installAll
  5. Copy the .env-example both in client and server to .env, add Slack credentials
  6. Add your change together with a test (tests are not needed for refactorings and documentation changes).
  7. Run npm run testAll and npm run format and ensure all tests are passing.
  8. 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