Skip to content
This repository has been archived by the owner on Mar 4, 2019. It is now read-only.

Docs: Added our commit template and instructions #178

Merged
merged 1 commit into from
Jan 7, 2019

Conversation

RobinCsl
Copy link
Collaborator

@RobinCsl RobinCsl commented Jan 7, 2019

Summary: This commit template is introduced to try and improve our commit message quality; the resulting git history will be more useful and documenting. Instructions on how to set it up were added to the contributing guidelines. (I also think that commit messages should start with a capital letter, so I modified the docs to reflect that.)

Summary: This commit template is introduced to try and improve our commit message quality; the resulting git history will be more useful and documenting. Instructions on how to set it up were added to the contributing guidelines. (I also think that commit messages should start with a capital letter, so I modified the docs to reflect that.)
Copy link
Contributor

@JosefDuda JosefDuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# `Fix`: bug fixes, e.g. fix some colors, paddings.
# `Feat`: new features, e.g. add new component.
# `Refactor`: code/structure refactor, e.g. new structure folder for components/ extracting component to separate file.
# `Docs`: changes into documentation,
# `Test`: adding or updating tests, e.g. unit, snapshot testing.
# `Chore`: tooling changes, e.g. change circle ci config.
# `BREAKING`: for changes that break existing usage, e.g. change API of a component.

It will be nice to maintain this block of description only in one place (currently also in CONTRIBUTING.md). But there isn't probably some better way to do it and it won't change much in the future so it's ok for me if we keep it this way.

@RobinCsl
Copy link
Collaborator Author

RobinCsl commented Jan 7, 2019

Yes, ideally it would come from one source of truth.

@RobinCsl RobinCsl merged commit 1648c7b into master Jan 7, 2019
@RobinCsl RobinCsl deleted the docs/git-commit-template branch January 7, 2019 14:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants