docs: integrate Epic workflow into DEVELOPMENT.md #71
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for managing large features that require multiple pull requests using GitHub's Epic and Sub-Issue pattern. The documentation helps team members understand how to break down complex features into smaller, trackable PRs while maintaining proper issue linking and project board automation.
Key Changes:
- Added "Working with Epics & Multi-PR Features" section explaining the Sub-Issue pattern
- Documented the quick start process, benefits, and template locations
- Added cross-references to detailed documentation files (EPIC_WORKFLOW.md, ISSUE50_RETROSPECTIVE.md)
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Adds 'Working with Epics & Multi-PR Features' section to DEVELOPMENT.md to provide quick access to the Epic & Sub-Issue workflow during developer onboarding.
Integration Benefits
This PR Includes
DEVELOPMENT.md: New 'Working with Epics & Multi-PR Features' section with:Related PRs
Testing
See
DEVELOPMENT.md'Working with Epics' section for integrated workflow guide.