Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.22 KB

Contributing

You are welcome to submit any bugs, issues and feature requests on this repository.

Pull Request Process

  1. Update the README.md with details of changes to the interface.

  2. Ensure that each of the commit messages are in the following style:

    Format: <type>(<scope>): <subject>

    Type:

    • feat: (new feature for the user, not a new feature for build script)
    • fix: (bug fix for the user, not a fix to a build script)
    • docs: (changes to the documentation)
    • style: (formatting, missing semi colons, etc; no production code change)
    • refactor: (refactoring production code, eg. renaming a variable)
    • test: (adding missing tests, refactoring tests; no production code change)
    • chore: (updating grunt tasks etc; no production code change)
    • perf: (performance improvements)

    Example

    feat(build): deterministic compile option
    ^--^ ^---^   ^--------------------------^
    |    |       |
    |    |       +-> Summary in present tense.
    |    |
    |    |
    |    +-------> Scope of the change.
    |
    +-------> Type: chore, docs, feat, fix, perf, refactor, style, or test.
    

    Reference