Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Latest commit

 

History

History
85 lines (57 loc) · 5.08 KB

README.md

File metadata and controls

85 lines (57 loc) · 5.08 KB
Raw

dogs 🐕

npm version Actions Status Maintenance Status

Formidable Dogs

Install

$ npm install @formidable/dogs
$ yarn add @formidable/dogs

Contributing

This repository is configured using semantic-release which automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.

What does this mean for contributors? It means we need a merge commit that follows the conventional commit format. There are lots of ways to do semantic-release and commit vetting, but here's how we do it in this repo:

  1. Our target for semantic-release is a "Squash and merge" GitHub pull request merge. Our repository only allows this kind of merge. We aim to have the final commit meet the conventional commit format.
    • Note: This means that along the way to that final merge commit, it doesn't matter how you commit. We don't do pre-commit hooks, nor lint individual commits in a pull request. All we check is the final merge commit to make sure it's all good.
  2. This means that the thing you need to check is the pull request title which is what will be used in the squash and merge commit to trigger semantic release. We use semantic-pull-requests(NO LONGER MAINTAINED) to make sure that our PRs have a title meet the eventual format needed. And no worries about changes along the way! You just need to get the PR title in appropriate shape by the time you want to merge.

There are very precise rules over how git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. Also, the git commit messages are used to generate the AngularJS change log.

Anatomy of a pull request title

The semantic-pull-requests bot goes for the minimal semantic-release information to make doing versioning as easy as possible. For how we do it in this project, you just need to focus on the PR title (that must be preserved in the squash and merge commit).

The pull request title has a special format that should include a type, a scope and a subject:

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

The scope of the header is optional.

What type of commits trigger a release?

Type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test].

Commit Types Description Version Impact
chore Changes to the build process N/A
docs Changes to documentation N/A
feat Changes that support a new feature Patch
fix Changes that fix a bug Minor
perf Changes that improve performance Patch
refactor Changes that neither fixes a bug nor adds a feature N/A
style Changes that do not affect the meaning of code N/A
test Changes to the test process N/A

What about major version bumps?

Major version bumps are considered breaking changes for semantic-release and are triggered intentionally.

Breaking changes should start with a ! after the commit type. This changes a usual N/A version impact of something like refactor or fix to a breaking change with refactor! or fix!.

Examples

Any of the following PR titles should work for the appropriate release:

  • perf: removed pictures from published package: Patch
  • refactor(utils): change internal file utils: N/A. Add an ad-hoc scope.
  • refactor: change internal function: N/A
  • refactor!: remove dog .jpg files: Major

Maintenance Status

Archived: This project is no longer maintained by Formidable. We are no longer responding to issues or pull requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!