Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.77 KB

File metadata and controls

68 lines (47 loc) · 1.77 KB

My pull request is failing! What Gives?

We use a tool called commitlint to keep our commit messages organized. This let's us automatically publish packages based on the type of commit.

If you're here, odds are your pull request or a subsequent commit didn't adhere to our guidelines.

So what do I do about it?!

We need a commit message that describes what's happening in your commit, let's build one.

Type

Commit messages need a type, pick the one below that best matches your commit:

Release: commits in this category will trigger a release of the package

  • fix: a bug fix (triggers a patch release)
  • feat: a new feature (triggers a minor release)

No release: commits in this category won't trigger a release

  • build: changes that affect the build system
  • ci: changes to our CI configuration
  • chore: dependency updates
  • docs: documentation changes
  • perf: performance improvements
  • refactor: code change that neither fixes a bug, nore adds a feature
  • test: adding or changing test files

Commit messages should look like this:

Structure

Your commit should look like this (keep everything lowercase, even React components):

type(scope): subject # scope is optional, it refers to a particular component/feature

The subject is just a short summary of the code changes

Examples

feat: add RTL support
fix(aside): remove aside margin

Fixing the PR

  1. On the command line, navigate to the repository that contains the commit you want to amend
  2. Type git commit --amend -m "type: subject" replacing the message with your own
  3. Use the push --force command to force push over the old commit:
git push --force _my-branch_