Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 2.54 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project.
Your help is essential for keeping it great.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Compile code: npm run compile
  4. Make sure the tests pass on your machine: npm run test
  5. Create your feature branch: git checkout -b my-new-feature
  6. Make your change, add tests, and make sure the tests still pass
  7. Add your changes: git add .
  8. Commit your changes: git commit -am 'Add some feature'
  9. Push to the branch: git push origin my-new-feature
  10. Submit a pull request
  11. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write and update tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Revert

If the commit reverts a previous commit it should begin with revert:, followed by the SHA of the reverted commit.
e.g: revert: commit <SHA>.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • chore: Maintain
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests