diff --git a/README.md b/README.md index 0b3a4fe..b2e5987 100644 --- a/README.md +++ b/README.md @@ -454,6 +454,33 @@ grokkit/ └── scripts/ # Install scripts ``` +### TODO Workflow + +**Policy:** +From now on, the only thing to be committed directly to the `master` branch will be to-do items (.md files in `todo/queued/`). + +**Process:** +1. When deciding to work on a to-do item: create a branch, implement on the branch, submit PR to `master`. +2. After PR merge: move the item to `todo/completed/`. + +**Example workflow:** +```bash +git checkout -b feature/some-todo +# Implement changes, test with make test lint +git add . +git commit -m "feat: implement some-todo" +git push -u origin feature/some-todo +# Create and merge PR to master + +# Post-merge: +git checkout master +git pull +mv "todo/queued/SOME_TODO.md" "todo/completed/SOME_TODO.md" +git add todo/ +git commit -m "chore: complete some-todo" +git push origin master +``` + ## Documentation - 📖 [Troubleshooting Guide](docs/TROUBLESHOOTING.md) - Common issues and solutions