Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

63 lines (47 loc) · 2.22 KB
Raw

Contributing to Vibranium

Well... let's keep it simple:

  1. Please follow the Code of Conduct
  2. Found a bug or unexpected behaviour? Please open an issue.
  3. Missing a feature? Please open an issue for that as well.
  4. Want to contribute? Great, just send a Pull Request and await feedback! :)

If you can, try to follow these simple commit message conventions:

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. The footer should contain a closing reference to an issue if any.

Samples:

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.
Type

Must be one of the following:

  • ci: Changes to our CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests
Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end
Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.