Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (16 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.67 KB

Contributing

Requirements

  • Node LTS
  • NPM

Tip: This repo support corepack. Just enable it corepack enable and this repo will warn you if you try to use another package manager.

Guidelines

  • Make sure your changes are fully tested (when applicable).
  • We tend to avoid comments in our code base, we strongly prefer good naming and code structure.
  • Avoid pushing similar changes in different commits if it's within the same feature, because we want the changelogs to be clear and simple. To avoid that, there are at least 2 options:
    1. Squash the commits into one when merging (you need to edit the final commit message though)
    2. amend the previous commit when making related changes (git commit --amend --no-edit)

Commit messages

Every commit message must comply with the Angular Commit Message Conventions specification. We use the commit messages to automatically bump the package version according to the semantic versionning notation. Moreover, we generate changlogs for each version using those commit messages.

  • You can either manually write a commit message that follows the convention using your favorite method.
  • Or you can run npm run commit-cli. It will prompt you some questions about the nature of your changes, then it will commit your staged changes along with a generated message that follows our convention.
  • Commits containing breaking changes need to be marked as such in the commit footer. See BREAKING CHANGE convention.