Skip to content

Commit 969627c

Browse files
Merge branch 'unstable' into docs/conventional-commits-update
2 parents f504408 + 6554dd8 commit 969627c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+569
-523
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,16 @@ Commit contents, in other words, the changes the commit introduce should:
117117
Example:
118118
feat(foo)!: introduce breaking change bar
119119
120+
120121
For more, see [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)
121122
123+
`patch-hub` follows the use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) wherein you indicate the type of change you're making at the start with a label, followed by a scope (optional, since the project is still small), and then the commit message after a colon. In case the commit is a breaking change, i.e it disrupts existing functionality, please use the `!` symbol before the `:` to indicate as such.
124+
125+
122126
Example Commits:
123-
- `feat: allow provided config object to extend other configs`
124-
- `docs: correct spelling of CHANGELOG`
127+
- Breaking change that introduces a feature to `config`: `feat(config)!: allow provided config object to extend other configs`
128+
- Bug fix to patch parsing logic: `fix(patch): fix incorrect title in patches`
129+
- Simple change to documentation: `docs: correct spelling of CHANGELOG`
125130
126131
Common prefixes:
127132
- `feat`: A new feature.

0 commit comments

Comments
 (0)