diff --git a/readme.md b/readme.md index de9d279..b7b1f39 100644 --- a/readme.md +++ b/readme.md @@ -1,23 +1,33 @@ +## Commit schema + +``` +[optional scope]: + +[optional body] + +[optional footer(s)] +``` + +> - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) +> - docs: Documentation only changes +> - feat: A new feature +> - fix: A bug fix +> - refactor: A code change that neither fixes a bug nor adds a feature +> - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +> - test: Adding missing tests or correcting existing tests + ## Emojis -Commit Type | Emoji +Type | Emoji ---------- | ----- -Category | ๐Ÿ“Œ (`:pushpin:`) -Add | โž• (`:heavy_plus_sign:`) -Remove | โž– (`:heavy_minus_sign:`) -Change | ๐Ÿ”ง (`:wrench:`) -Merge | ๐Ÿ”€ (`:twisted_rightwards_arrows:`) -Release or Initial Commit | ๐ŸŽ‰ (`:tada:`) -Release or Version Tag | ๐Ÿ”– (`:bookmark:`) -New Feature | โœจ (`:sparkles:`) -Bugfix | ๐Ÿ”จ (`:hammer:`) -Security Update | ๐Ÿ”’ (`:lock:`) -WIP | ๐Ÿšง (`:construction:`) -Tests | ๐Ÿงช (`:test_tube:`) -Deprecation | ๐Ÿ—‘๏ธ (`:wastebasket:`) -Documentation | ๐Ÿ“— (`:green_book:`) -Cleanup | ๐Ÿ“ (`:file_folder:`) +build | ๐Ÿ‘ทโ€โ™‚๏ธ +docs | ๐Ÿ“— +feat | โœจ +fix | ๐Ÿ”จ +refactor | ๐Ÿ”ง +style | ๐Ÿ“‹ +test | ๐Ÿงช ### Credits -[gitmoji](https://gitmoji.dev/) | [commit message emoji](https://github.com/dannyfritz/commit-message-emoji) +https://www.conventionalcommits.org/en/v1.0.0/ \ No newline at end of file