methodology/README.md

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
• gitmoji
• planning
• ideation / design (coming soon)
  • design process
• development
• documentation
• Deployment (coming soon)
• Launch (coming soon)
• Maintenance (coming soon)
• data management
• tools (🚧 under construction 🚧)
• philosophy
• scripts
  • emoji_shortlist

roadmap

• 2022Q3: Consultancy & Delivery Methodology
  • Planning
  • taiga.ai learning lessons Contract clauses, Project phases, Deliverables
• 2023Q1: Data Management 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? Take a look at word emojis with short shortcodes made by this script this script Submit an issue (or Pull Request).

git version control

• repo naming conventions
  • lowercase
  • dashes not underscores
  • name pattern: <prefix>_<suffix>
    • <prefix> i.e. drug, condition, indication, area (reserach, clinical)
    • <suffix> i.e. project name, tool, exploration name
• init repo with README
  • must have sections: purpose, usage and stakeholders sections
  • good to have: install, contributing
• git rules for simple development
  • no branching
  • no rebasing
  • no public repos
  • no data in repo