-
Notifications
You must be signed in to change notification settings - Fork 76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update git flow convention in documentation #527
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good. Added a couple links to RELEASES/CONTRIBUTING docs and had some questions on how we want to handle hotfixes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Mikey and Mitchel, no edits from me.
fixes links and edits Co-authored-by: mitchelbaker-cisa <[email protected]>
OK @mitchelbaker-cisa I think all your comments are covered in the new changes I'm pushing... let me know, and I'll let you or roger go ahead and merge this
https://github.com/cisagov/LME/blob/hotfix-mreeve-523/RELEASES.md OK @mitchelbaker-cisa I think all your comments are covered in the new changes I'm pushing... let me know, and I'll let you or roger go ahead and merge this it also looks like the linux test is still having issues, but hopefully we can get that fixed up soon :) |
Thanks Mikey! Now that I'm thinking about it, we could automate the post merge step if we wanted to.. maybe something we can add to our pipeline later on. https://stackoverflow.com/questions/67668006/how-to-automatically-merge-a-branch-into-another-in-github |
🗣 Description
Adds new branching convention to releases/contributing docs.
💭 Motivation and context
We have 2 main branches whose names will stay constant:
main
branch tracks Major/Minor/Patch releases only, and is only updated with merges from thedevelop
or ahotfix
branch. Releases are tagged appropriate SEMVERs based on their content:vX.Y.Z
.develop
branch is our working copy of latest changes, and tracks all feature development. Feature branches are merged intodevelop
as features are added, and when readydevelop
will merge into main as documented above.There are 2 other branch naming conventions that change based on the issue/update/content they add to the project.
hotfix
branch is created to "fix" or "patch" a critical issue in themain
branch of the LME repository. Hotfixes are branched frommain
and merged intodevelop
. This waymain
can get fixes, anddevelop
will be synced withmain
.- It uses the convention:
hotfix-<username>-<issue#>-<shortstring>
- An example:
hotfix-cbaxley-222-fix-the-pipeline
develop
to add content for issues/work/updates/etc...- It uses the convention: -<issue #>-shortstring
- An example:
mreeve-22-filter-events
NOTE: Each branch name will have a short string to describe what it is solving for example
create-new-container
:📷 Screenshots (DELETE IF UNAPPLICABLE)
🧪 Testing
Displays properly on github wiki.
✅ Pre-approval checklist
the title reflects this in a clear human readable format
✅ Pre-merge Checklist
✅ Post-merge Checklist