Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

95 lines (58 loc) · 2.59 KB
Raw

Contributing

You want to something for this repo? Nice. You are the best!

Issues

General

If you report a bug, please try to:

  • Perform a web / GitHub search to avoid creating a duplicate ticket.
  • Include enough information to reproduce the problem.
  • Mention the exact version of the project causing you problems, as well as any related software and versions (such as operating system, browser, etc.).
  • Test against the latest version of the project (and if possible also the master branch) to see if the problem has already been fixed.

Once you have tried the above, create a GitHub issue notifying your bug report.

Working in the code

If you want to contribute code, please:

  • Follow the same coding style as used in the project.
  • Add an automated test that verifies your code change like described in the Tests chapter.
  • Write good commit messages, explain what your patch does, and why it is needed. How to is described in the Commit changes chapter.
  • Keep it simple: Any patch that changes a lot of code or is difficult to understand should be discussed before you put in the effort.

Once you have tried the above, create a GitHub pull request with your changes changes and feel awesome 🎉.

Environment

Tested with Node 10 and up.

Setup

Clone the repo and run an installation:

git clone git@github.com:MartinHelmut/krieselreihe.git && cd krieselreihe && pnpm install

Build

To create a production build of the application:

pnpm build

Tests

Tests are written in Jest. To run all tests execute

pnpm test

To lint all the code:

pnpm lint

Format check

You can also run a prettier verification for all JS files in all packages with:

pnpm format:check

This will list changes that would be made on the commit (commit hook is installed with husky).

Commit changes

This repo is Commitizen-friendly! (read more)

Checkout a new branch, e.g.:

git checkout -b task/do-something

There is no specific naming convention for branches.

Add your changes and run pnpm commit to start the commitizen cli to create a proper commit message.

Create a "Pull Request" on Github and be awesome! 😎

Be Nice

Please follow the defined code of conduct.