This repository has been archived by the owner on Apr 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(other): adds commitlint and commitzen (#52)
Add commitlint and commitzen to the project to promote and enforce conventional comments. https://conventionalcommits.org
- Loading branch information
1 parent
74148a9
commit 6fff3b7
Showing
4 changed files
with
1,807 additions
and
2,391 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"extends": [ | ||
"@commitlint/config-conventional", | ||
"cz" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
const types = [ | ||
` feat: A new feature`, | ||
` fix: A bug fix`, | ||
` docs: Documentation only changes`, | ||
` style: Changes that do not affect the meaning of the code | ||
(white-space, formatting, missing semi-colons, etc)`, | ||
` refactor: A code change that neither fixes a bug nor adds a feature`, | ||
` perf: A code change that improves performance`, | ||
` test: Adding missing tests`, | ||
` revert: Revert to a commit`, | ||
` WIP: Work in progress`, | ||
` chore: Changes to the build process or auxiliary tools | ||
and libraries such as documentation generation` | ||
]; | ||
|
||
const messages = { | ||
type: `Select the type of change that you're committing:`, | ||
|
||
subject: `Write a SHORT, IMPERATIVE tense description of the change:\n`, | ||
|
||
body: `Provide a LONGER description of the change (optional). Use "|" to break new line:\n`, | ||
|
||
breaking: `Describe any BREAKING CHANGES (optional):\n`, | ||
|
||
footer: ` List any RELATED ISSUES to this change (optional).\n`, | ||
|
||
confirmCommit: `Are you sure you want to proceed with the commit above?` | ||
}; | ||
|
||
const scopes = [ | ||
"card", | ||
"clientpicker", | ||
"createaddress", | ||
"hermit", | ||
"slices", | ||
"testrunner", | ||
"wallet", | ||
"other", | ||
]; | ||
|
||
module.exports = { | ||
types: types.map((type) => ({ | ||
value: type.split(":")[0].trim(), | ||
name: type | ||
})), | ||
|
||
scopes: scopes.map((scope) => ({ | ||
name: scope | ||
})), | ||
|
||
messages, | ||
|
||
subjectLimit: 65, | ||
allowCustomScopes: false, | ||
allowTicketNumber: false, | ||
allowBreakingChanges: ["feat", "fix"], | ||
breakingPrefix: "BREAKING CHANGE:", | ||
footerPrefix: "ISSUES:" | ||
}; |
Oops, something went wrong.