dannydannydanny/methodology
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

vimwiki: dth @ DK023900WSL

Browse source
This commit is contained in:
DannyDannyDanny 2022-10-21 14:08:03 +02:00
parent a338bfaace
commit b1df420b21
2 changed files with 2400 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -27,28 +27,33 @@ This guide focuses on designing, developing ~~and delivering~~ Data-Processing S
## `git`moji reference
Use the format `:gitmoji: <commit message>` in your commit messages. Only proper nouns, CamelCase and class names should have uppercases letters. ~~Avoid using multiple gitmojis.~~ Use several gitmojis if it makes sense.
Use the format `:gitmoji: <commit message>` in your commit messages.
Or follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
Only proper nouns, CamelCase and class names should have uppercases letters.
Use several gitmojis if it makes sense.
|emoji|code|description|
|---|---|---|
|:sparkles:|`:sparkles:`| add new feature / function |
|:art:|`:art:`| refactor code / add type hinting / improve readibility / structure and lint flake8 |
|:goal_net:|`:goal_net:`| try/raise/handle errors or warnings |
|:zap:|`:zap:`| improve performance / coverage / profiling |
|:bug:|`:bug:`| bug fixing |
|:truck:|`:truck:`| moving / renaming |
|:recycle:|`:recycle:`| work related to CI/CD, pre-commit hooks, automated tests and environments |
|:boom:|`:boom:`| work in progress / breaking changes |
|:memo:|`:memo:`| doc / logging / verbosity / code comments |
|:fire: |`:fire:`| remove (dead) code / file |
|:alien:|`:alien:`| changes related to APIs, Databases, Network etc. |
|:tada:|`:tada:`| clean / transform / validate _data_ |
|:eyes:|`:eyes:`| improve UI / UX, CLI or visualizations (previously :lipstick:) |
|:brain:|`:brain:`| statistical modelling, training and prediction |
|:pushpin:|`:pushpin:`| dependency and environment versioning |
|:whale: |`:whale:`| virtualization, containerization and architecture changes |
|:see_no_evil:|`:see_no_evil:`| changes to `.*ignore` or local files |
|:mag: |`:mag:`| PR-review change-requests |
| emoji | code | description |
|---------------|-----------------|---------------------------------------------------------------------------|
| :sparkles: | `:sparkles:` | add new feature / function |
| :art: | `:art:` | refactor / type hinting / restructuring / linting |
| :goal_net: | `:goal_net:` | try/raise/handle errors or warnings |
| :zap: | `:zap:` | improve performance / coverage / profiling |
| :bug: | `:bug:` | bug fixing |
| :truck: | `:truck:` | moving / renaming |
| :recycle: | `:recycle:` | CI/CD, pre-commit hooks, automated tests and environments |
| :boom: | `:boom:` | work in progress / breaking changes |
| :memo: | `:memo:` | doc / logging / verbosity / code comments |
| :fire: | `:fire:` | remove (dead) code / file |
| :alien: | `:alien:` | changes related to APIs, Databases, Network etc. |
| :key: | `:key:` | security, user access, roles |
| :tada: | `:tada:` | clean / transform / validate _data_ |
| :eyes: | `:eyes:` | UI / UX / CLI / visualizations (previously :lipstick:) |
| :brain: | `:brain:` | statistical modelling, training and prediction |
| :pushpin: | `:pushpin:` | dependency and environment versioning |
| :whale: | `:whale:` | virtualization, containerization and architecture changes |
| :see_no_evil: | `:see_no_evil:` | changes to `.*ignore` or local files |
| :mag: | `:mag:` | PR-review change-requests |
Missing a gitmoji? Take a look at [word emojis with short shortcodes](emojis.md)
made by this script [this script](scripts/emoji_shortlist.py)