diff --git a/src/tools/git-semantic-commit-memo/git-sem.memo.md b/src/tools/git-semantic-commit-memo/git-sem.memo.md new file mode 100644 index 00000000..40071693 --- /dev/null +++ b/src/tools/git-semantic-commit-memo/git-sem.memo.md @@ -0,0 +1,34 @@ +# Semantic Commit Messages + +See how a minor change to your commit message style can make you a better programmer. + +Format: `(): ` + +`` is optional + +## Example + +``` +feat: add hat wobble +^--^ ^------------^ +| | +| +-> Summary in present tense. +| ++-------> Type: chore, docs, feat, fix, refactor, style, or test. +``` + +More Examples: + +- `feat`: (new feature for the user, not a new feature for build script) +- `fix`: (bug fix for the user, not a fix to a build script) +- `docs`: (changes to the documentation) +- `style`: (formatting, missing semi colons, etc; no production code change) +- `refactor`: (refactoring production code, eg. renaming a variable) +- `test`: (adding missing tests, refactoring tests; no production code change) +- `chore`: (updating grunt tasks etc; no production code change) + +References: + +- https://www.conventionalcommits.org/ +- https://seesparkbox.com/foundry/semantic_commit_messages +- http://karma-runner.github.io/1.0/dev/git-commit-msg.html \ No newline at end of file diff --git a/src/tools/git-semantic-commit-memo/git-semantic-commit-memo.vue b/src/tools/git-semantic-commit-memo/git-semantic-commit-memo.vue new file mode 100644 index 00000000..be7d748f --- /dev/null +++ b/src/tools/git-semantic-commit-memo/git-semantic-commit-memo.vue @@ -0,0 +1,22 @@ + + + + + diff --git a/src/tools/git-semantic-commit-memo/index.ts b/src/tools/git-semantic-commit-memo/index.ts new file mode 100644 index 00000000..80b1e74d --- /dev/null +++ b/src/tools/git-semantic-commit-memo/index.ts @@ -0,0 +1,13 @@ +import { GitCommit } from '@vicons/tabler'; +import { defineTool } from '../tool'; + +export const tool = defineTool({ + name: 'Git Semantic Commit Cheatsheet', + path: '/git-semantic-commit-memo', + description: 'Cheatsheet for committing using semantic prefixes', + keywords: ['git', 'semantic', 'commit', 'cheatsheet'], + component: () => import('./git-semantic-commit-memo.vue'), + icon: GitCommit, + createdAt: new Date('2025-05-01'), + category: 'Cheatsheets', +});