41 lines
2.2 KiB
Markdown
41 lines
2.2 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 projects with som external dependencies (APIs or DBs).
|
|
In your commit message use the format `:gitmoji: [commit message]`. Only propper nouns, CamelCase and class names should have uppercases letters. 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 [Pull Request](https://github.com/DannyDannyDanny/gitmoji/pulls)).
|
|
|
|
## `gitmoji` Lookup
|
|
|
|
|emoji|code|description|
|
|
|---|---|---|
|
|
|:sparkles:|`:sparkles:`| add new feature / function|
|
|
|:art:|`:art:`| improve readibility / structure and lint flake8 |
|
|
|: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:`| changes related to APIs and Databases |
|
|
|:bar_chart:|`:bar_chart:`| clean / transform / validate _data_|
|
|
|:lipstick:|`:lipstick:`| improve UI / UX, CLI or visualizations|
|
|
|:pushpin:|`:pushpin:`| Dependency and environment versioning |
|
|
|:see_no_evil:|`:see_no_evil:`| changes to .gitignore and exclusively local files |
|
|
|
|
## 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)
|
|
* Audit [security](https://hangar.tech/posts/our-dsq/)
|
|
* Use [non-linear roadmaps](https://productcrunch.substack.com/p/escaping-the-roadmap-trap)
|
|
* Use solarized-theme
|
|
* [git bash solarized :sun_with_face:](https://github.com/speedpacer/gitbash_solarized/issues)
|