From 2d772fe5a7f8ec970e50314630edf196ecdff049 Mon Sep 17 00:00:00 2001 From: Holger Schmermbeck Date: Sun, 2 Nov 2025 11:42:26 +0100 Subject: [PATCH] docs: integrate Epic workflow into DEVELOPMENT.md Adds 'Working with Epics & Multi-PR Features' section to DEVELOPMENT.md to provide quick access to the Epic & Sub-Issue workflow. Integration Benefits: - Developers discover workflow during onboarding - Quick start guide with practical examples - Links to comprehensive documentation - Benefits breakdown for decision-making This PR includes: - DEVELOPMENT.md: New 'Working with Epics' section with quick start, benefits summary, template locations, and documentation links Related: - Core workflow: SecPal/api #69 - Case study: SecPal/api #70 - Organization templates: SecPal/.github #157 See Also: DEVELOPMENT.md 'Working with Epics' section --- DEVELOPMENT.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index c30ee07..55a8b60 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -313,8 +313,53 @@ echo "βœ… Ready for PR!" - ❌ Replying with "Fixed" in comments (clutters thread) - βœ… Push fix, let GitHub detect outdated comment, resolve thread +## Working with Epics & Multi-PR Features + +For large features requiring multiple PRs (like Issue #50 with 7 PRs), use the **Sub-Issue pattern**: + +### Quick Start + +1. **Create Epic Issue**: Use organization template "πŸ—ΊοΈ Epic (Multi-PR Feature)" +2. **Create Sub-Issues**: One per PR using "πŸ“¦ Sub-Issue (Part of Epic)" template +3. **Link Sub-Issues**: Update epic's tasklist with sub-issue references +4. **PR References**: + - Each PR: `Fixes #` + - ONLY last PR: `Closes #` + +### Why? + +- βœ… Automatic progress tracking in GitHub Projects ("5 of 7 complete") +- βœ… Granular status per PR (not just epic-level) +- βœ… Epic stays open until ALL PRs are merged +- βœ… Clear dependencies between PRs + +### Templates + +The Epic and Sub-Issue templates are **organization-wide** (in `SecPal/.github`): + +- Available when creating issues in any SecPal repository +- YAML format with interactive form fields +- Consistent across all projects + +### Full Documentation + +See [docs/EPIC_WORKFLOW.md](./docs/EPIC_WORKFLOW.md) for complete guide including: + +- When to use epics vs regular issues +- How to create and link sub-issues +- Project board automation +- Real-world example (Issue #50 retrospective) +- Best practices and FAQ + +**Related Documentation:** + +- [EPIC_WORKFLOW.md](./docs/EPIC_WORKFLOW.md) - Complete workflow guide +- [ISSUE50_RETROSPECTIVE.md](./docs/ISSUE50_RETROSPECTIVE.md) - Case study +- [EPIC_IMPLEMENTATION_SUMMARY.md](./docs/EPIC_IMPLEMENTATION_SUMMARY.md) - Quick reference + ## Documentation - [Database Schema](./docs/database-schema.md) - [Encryption Strategy](./docs/ENCRYPTION_STRATEGY.md) - [Database Decisions](./docs/DATABASE_DECISIONS.md) +- [Epic Workflow](./docs/EPIC_WORKFLOW.md) - Multi-PR feature tracking