An combination of Gitm😂ji and Angular convention with some tweaks on my part.
We use angular's commit messages format and with gitmoji added at the beginning.
<gitmoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Examples:
📝 docs(api): update api doc
Add chore and wip to basic angular commit types.
| Types | Gitmoji | Description |
|---|---|---|
feat |
✨ (normal) vs. 💥 (breaking change) | New features |
fix |
🐛 (normal) vs 🚑️ (hotfix) | Bug fix |
build |
👷 | Changes that affect the build system or external dependencies |
ci |
💚 | Changes to our CI configuration files and scripts |
docs |
📝 | Documentation only changes |
perf |
⚡️ | Improve performance |
refactor |
♻️ | Refactor code |
style |
🎨 | Improve structure/format of the code |
test |
✅ | Add, update or pass tests |
chore |
🔵 | Something that doesn’t fit the other types |
wip |
🚧 | Working in progress |
- pre-commit-hooks: Some out-of-the-box hooks for pre-commit.
We are using ruff in this repo because it can be used to replace most of the other tools.
- ruff: Extremely fast Python linter and code formatter that support lint rules from many popular tools like Flake8, isort, etc.
- mypy: Static Typing for Python.
- flake8: Plugin for flake8 (wrap PyFlakes, pycodestyle, McCabe)
- black: Uncompromising Python code formatter.
- isort: Python code formatter for sorting and categorizing imports.
- autoflake: Tool to removes unused imports/variables as reported by pyflakes.
- pyupgrade: Tool to automatically upgrade syntax for newer versions of the language.
- doctoc: Tool to generates table of contents for markdown files.
- markdownlint: Markdown lint tool.
- codespell: Tool for code misspellings checking.
pre-commit.ci: GitHub app for pre-commit.