Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (33 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.01 KB
Raw

How to contribute

We love pull requests. And following this guidelines will make your pull request easier to merge.

If you want to contribute but don’t know what to do, take a look at these two labels: help wanted and good first issue.

Use GitHub interface for simple documentation changes, otherwise follow the steps below.

Prerequisites

Development workflow

ALways start from develop branch and merge back to develop branch.

To build you changes run:

npm run build

Run linters and tests:

npm test

Or run tests in watch mode:

npm test --watch

Don’t forget to add tests and update documentation for your changes. Documentation can be archived by using JSDoc.

Please update npm lock file (package-lock.json) if you add or update dependencies.

Other notes

  • If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
  • We’re using Prettier to format code, so don’t worry much about code formatting.
  • Use Conventional Commits, like so: feat(scope): topic
  • Don’t commit generated files, like minified JavaScript.
  • Don’t change version number and changelog.

Need help?

If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with WIP (Work in progress) in its title and ask questions in the pull request description.