feat(rules): separate Feature Implementation Workflow from git-workflow.md (fixes #235)#278
Conversation
…low.md (refs affaan-m#235) Removed the Feature Implementation Workflow section from the Git Workflow document.
…Workflow (refs affaan-m#235) This document outlines the full feature development process, including planning, TDD, code review, and committing to git.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR separates feature development workflow documentation from git-specific workflow concerns by extracting the four-step feature implementation process (Plan, TDD, Code Review, Commit) into a dedicated development-workflow.md file and consolidating git-workflow.md to focus exclusively on git-related operations with a reference to the new document. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR resolves #235 by separating the general Feature Implementation Workflow from the git-focused guidance, keeping git-workflow.md narrowly scoped to git/PR concerns and moving development-process guidance into a new dedicated document.
Changes:
- Removed the “Feature Implementation Workflow” section from
rules/common/git-workflow.mdand added a reference to the new doc. - Added
rules/common/development-workflow.mdcontaining the Feature Implementation Workflow and a cross-reference back togit-workflow.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| rules/common/git-workflow.md | Removes non-git development-process guidance and links to the new development workflow doc. |
| rules/common/development-workflow.md | New doc housing the end-to-end feature implementation workflow with a link back to git workflow details. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 4. **Commit & Push** | ||
| - Detailed commit messages | ||
| - Follow conventional commits format | ||
| > For the full development process (planning, TDD, code review) before git operations, |
There was a problem hiding this comment.
The phrase "before git operations" is inaccurate now that the referenced development workflow includes a "Commit & Push" step (i.e., git operations). Consider rewording to something like "for the broader development process (planning, TDD, code review) that complements this git workflow" to avoid a contradiction.
| > For the full development process (planning, TDD, code review) before git operations, | |
| > For the broader development process (planning, TDD, code review) that complements this git workflow, |
| > This file extends [common/git-workflow.md](./git-workflow.md) with the full feature development process that happens before git operations. | ||
|
|
||
| The Feature Implementation Workflow describes the development pipeline: planning, TDD, code review, and then committing to git. |
There was a problem hiding this comment.
This intro says the workflow "happens before git operations", but the file later includes "Commit & Push" which is a git operation. Reword the intro to avoid the internal inconsistency (e.g., describe it as the end-to-end development workflow including committing/pushing).
| > This file extends [common/git-workflow.md](./git-workflow.md) with the full feature development process that happens before git operations. | |
| The Feature Implementation Workflow describes the development pipeline: planning, TDD, code review, and then committing to git. | |
| > This file extends [common/git-workflow.md](./git-workflow.md) with the end-to-end feature development process, from planning through commit and push. | |
| The Feature Implementation Workflow describes the end-to-end development pipeline: planning, TDD, code review, and then committing and pushing to git. |
| > This file extends [common/git-workflow.md](./git-workflow.md) with the full feature development process that happens before git operations. | ||
|
|
||
| The Feature Implementation Workflow describes the development pipeline: planning, TDD, code review, and then committing to git. |
There was a problem hiding this comment.
The rules index in rules/README.md enumerates the files under rules/common/, but it doesn't include this new development-workflow.md. To keep the documentation consistent/discoverable, update the index to include the new file (and possibly clarify the separation between development vs git workflow).
| > This file extends [common/git-workflow.md](./git-workflow.md) with the full feature development process that happens before git operations. | |
| The Feature Implementation Workflow describes the development pipeline: planning, TDD, code review, and then committing to git. | |
| > This file complements [common/git-workflow.md](./git-workflow.md) by describing the feature implementation steps that happen **before** any git branching, committing, or PR activity. | |
| The Feature Implementation Workflow covers the development pipeline (planning, TDD, code review) up to the point where changes are ready to be committed, while `git-workflow.md` documents how to manage branches, commits, and pull requests. |
affaan-m
left a comment
There was a problem hiding this comment.
Automated review: doc-only changes look good. Approving.
…ent-workflow-235 feat(rules): separate Feature Implementation Workflow from git-workflow.md (fixes affaan-m#235)
Description
Resolves #235
Splits the Feature Implementation Workflow out of
rules/common/git-workflow.mdinto a new dedicatedrules/common/development-workflow.mdfile.Changes
rules/common/git-workflow.md: Removed the Feature Implementation Workflow section; now focuses exclusively on git-specific concerns (commit message format, PR workflow). Added a reference to the newdevelopment-workflow.md.rules/common/development-workflow.md(new file): Contains the Feature Implementation Workflow (Plan First → TDD → Code Review → Commit & Push), with cross-reference back togit-workflow.mdfor commit format.Type of Change
refactor:Code refactoring (moving content between files)feat:New feature (new filedevelopment-workflow.md)Summary by CodeRabbit