Skip to content

Commit 3d665d6

Browse files
committed
docs: enhance CONTRIBUTING guide
Signed-off-by: Maximillian Arruda <[email protected]>
1 parent ca64c41 commit 3d665d6

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONTRIBUTING.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,18 +98,18 @@ To contribute to the repo one must adhere to the following:
9898
**Types of Commits:**
9999

100100
- **fix:** Any commit that patches a bug anywhere in the codebase
101-
- **feat:** Any commit that introduces a new feature or focuses on enhancing the scope of exisiting features
101+
- **feat:** Any commit that introduces a new feature or focuses on enhancing the scope of existing features
102102
- **breaking changes:** Any commit that has a footer "BREAKING CHANGE", or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
103-
- **other than fix and feat:** Any commit that consists of the following keywords: build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. For other keywords refer to https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional[@commitlint/config-conventional] (based on the Angular convention)
103+
- **other than fix and feat:** Any commit that consists of the following keywords: `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. For other keywords refer to https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional[@commitlint/config-conventional] (based on the Angular convention)
104104
- **other footers:**<description> may be provided and follow a convention similar to https://git-scm.com/docs/git-interpret-trailers[git trailer format]
105105

106106
**Examples of commits**
107107

108-
- **Regular Commit Message:** This may be used for either fix or feat and can be wriiten as "fix:<message>" or "feat:<message>"
109-
- **Commit with breaking change**: Example: A new feature being introduced as a breaking change can be written as "feat!:<message>", this can also simply be written as a regular feat with the "BREAKING CHANGE" appended to it at the end of the commit
110-
- **Specific breaking change:**: Example: A breaking change introduced with a new feature somewhere in the api can be written as "feat(api)!:<message>"
111-
- **Changing the docs:** "docs:<message>"
112-
- **Regular commit message with specificaton:** A new feature introduced in the api can be written as "feat(api):<message>"
108+
- **Regular Commit Message:** This may be used for either fix or feat and can be written as `fix: <message>` or `feat: <message>`
109+
- **Commit with breaking change**: Example: A new feature being introduced as a breaking change can be written as `feat!: <message>`, this can also simply be written as a regular feat with the *BREAKING CHANGE* appended to it at the end of the commit
110+
- **Specific breaking change:**: Example: A breaking change introduced with a new feature somewhere in the api can be written as `feat(api)!: <message>`
111+
- **Changing the docs:** `docs: <message>`
112+
- **Regular commit message with specification:** A new feature introduced in the api can be written as `feat(api): <message>`
113113

114114
**Formatting Commit messages**
115115

0 commit comments

Comments
 (0)