diff --git a/README.md b/README.md index 9a0a789..0152bed 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ Repository for CDS-2020 Programming and Promt Engineering II +# Commits convention +|Prefix|Description|Example| +|-|-|-| +|feat|New feature|feat: add price prediction model| +|fix|Bugfix|fix: correct null pointer in loader| +|chore|Maintenance tasks, no logic changes|chore: update README| +|docs|Documentation|docs: add API reference| +|refractor|Code restructured, no new behavior|refactor: extract helper function| +|test|Tests added/changed|test: add unit tests for mod_a| +|style|Formatting, no change in logic|style: run black formatter| +|ci|CI/CD Pipeline change|ci: add GitHub Actions workflow| +|perf|Performance improvement|perf: optimize OSRM batch requests| +|build|Build-System, Dependencies|build: update requirements.txt| + # Codewars |Title|Source (src/codewars/)|Test (test/codewars/)|URL| |-|-|-|-|