contributing.md

Contributing Guide

Table of Contents

• Contributing Guidelines

• Code Style Guide

  • Lint the Code

  • Use EditorConfig

Contributing Guidelines

Here is some advice on how to craft a pull request with the best possible chance of being accepted:

• Follow code style guides.

• Write tests.

• Write documentation.

• Write good commit messages.

• Don't change the library version.

• Add an entry to Unreleased section in CHANGELOG.

• Squash related commits when the PR is ready to merge.

Code Style Guide

Lint the Code

The project follows JavaScript Standard Style. To lint the code, run:

npm run lint

Use EditorConfig

The project uses EditorConfig to define basic coding style guides. Please install a plugin for your editor of choice or manually enforce the rules listed in .editorconfig.