Repository navigation
Revise README: Remove milestones and update branching - #20
Conversation
Removed detailed development milestones and added branching strategy.
There was a problem hiding this comment.
Pull request overview
Updates the project README to remove the previously detailed milestone plan and document a dev-based branching workflow for ongoing development.
Changes:
- Removed the “Development Milestones” section from the README.
- Updated the branching strategy text to introduce a
devbranch and describe a feature-branch workflow viadev.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **`main`** is always buildable. Never commit directly to it. | ||
| - Every **feature on a branch** (`feature/short-description`). | ||
| - When a feature is complete: open a Pull Request, review diff, merge. | ||
| - **`dev`** is the development branch. | ||
| - Every **feature on a branch** (`feature/short-description`) is branched off from dev. | ||
| - When a feature is complete: open a Pull Request, review diff, merge to dev, then to main. |
There was a problem hiding this comment.
The branching diagram/code block above still shows feature branches coming directly off main, but the bullets now define dev as the integration branch and features branching from dev. Please update the diagram to reflect dev (and the correct branch-off point) so the README is internally consistent.
| - Gives a clean history that someone can actually read later | ||
| - The tags mean someone can always `git checkout milestone-1` and have a working app | ||
|
|
There was a problem hiding this comment.
The README still instructs tagging and checking out milestone-* (e.g., milestone-1), but the "Development Milestones" section was removed in this PR, so these tags no longer have documented meaning. Either remove/rename the milestone tagging guidance (e.g., to release tags) or reintroduce a brief definition of what each milestone tag represents.
|
@copilot apply changes based on the comments in this thread |
…release tags Agent-Logs-Url: https://github.com/sromic1990/Doculith/sessions/52d76d9e-c0d6-419f-9b50-af40344944de Co-authored-by: sromic1990 <13477194+sromic1990@users.noreply.github.com>
Applied both fixes in commit
|
Removed detailed development milestones and added branching strategy.