methodology/README.md
2022-03-21 17:59:28 +01:00

3.1 KiB

DannyDannyDanny/Methodology

This guide focuses on designing, developing and delivering Data-Processing Sytems, written primarily in python, deploying to Linux servers, optionally communicating with external interfaces (APIs or DBs). The repo is actively being updated; bookmark 🔖 it, leave a Star or Watch 👁️ the repo.

Repo Roadmap

  • 2021Q3: Decide on sections
  • 2021Q4: Split files (Development, Delivery)
  • 2022Q1: Run linux on dev machine (issue #5)
  • 2022Q2: Move dotfiles to own repo (and install script)
  • 2022Q3: Consultancy Methodology
  • 2022Q4: Delivery Methodology + git commit template
  • 2023Q1: Consultancy Methodology

Gitmoji 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.

emoji code description
:sparkles: add new feature / function
🎨 :art: refactor code / add type hinting / improve readibility / structure and lint flake8
🥅 :goal_net: try/raise/handle errors or warnings
:zap: improve performance / coverage / profiling
🐛 :bug: bug fixing
🚚 :truck: moving / renaming
♻️ :recycle: work related to CI/CD, pre-commit hooks, automated tests and environments
💥 :boom: work in progress / breaking changes
📝 :memo: doc / logging / verbosity / code comments
🔥 :fire: remove (dead) code / file
👽 :alien: changes related to APIs, Databases, Network etc.
🎉 :tada: clean / transform / validate data
👀 :eyes: improve UI / UX, CLI or visualizations (previously 💄)
🧠 :brain: statistical modelling, training and prediction
📌 :pushpin: dependency and environment versioning
🐳 :whale: virtualization, containerization and architecture changes
🙈 :see_no_evil: changes to .*ignore or local files
🔍 :mag: PR-review change-requests

Missing a gitmoji? Get inspiration. Submit an issue (or Pull Request).