methodology/README.md
2021-01-04 10:59:00 +01:00

36 lines
1.7 KiB
Markdown

## Welcome to DannyDannyDanny/gitmoji
<a href="https://gitmoji.carloscuesta.me">
<img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
</a>
This gitmoji repo is focused on Python Data Processing based software engineering with a database.
To render emoji's view [index via GitHub version](https://github.com/DannyDannyDanny/gitmoji/blob/gh-pages/index.md).
In your commit message use the format `:gitmoji: commit message`. Avoid using multiple gitmojis.
Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908).
Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or PR).
## `gitmoji` Lookup
|emoji|code|description|
|---|---|---|
|:sparkles:|`:sparkles:`| add new feature / function|
|:art:|`:art:`| improve readibility / structure and fix flake8 errors |
|:goal_net:|`:goal_net:`| try/raise/handle errors or warnings|
|:zap:|`:zap:`| improve performance / coverage / profiling |
|:bug:|`:bug:`| fix this bug|
|:truck:|`:truck:`| moving / renaming |
|:recycle:|`:recycle:`| refactor code |
|:construction:|`:construction:`| work in progress |
|:white_check_mark:|`:white_check_mark:`| writing tests, running tests |
|:memo:|`:memo:`| doc / logging / verbosity / code comments |
|:fire:|`:fire:`| remove code / file |
|:alien:|`:alien:`| API and Database related work |
|:bar_chart:|`:bar_chart:`|Clean / transform / validate _data_|
|:lipstick:|`:lipstick:`| Improve UI / UX, CLI or visualizations|
## Other methdology
* Follow [naming conventions](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html)
* Use [scrum methodology](https://www.scruminc.com/scrum-glossary/)
* Avoid [dark patterns](https://darkpatterns.org/types-of-dark-pattern.html)