-
Notifications
You must be signed in to change notification settings - Fork 45
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
feat: Update closed contribution documentation with new branch #330
Conversation
Thanks to some follow up work by @eepifanova, we can now target the main branch for closed content work. This commit updates the documentation to reference the main branch, and also adds specificity of origin and remote when referencing it for clarity. It also adds missing punctuation, and adjusts spacing in an early paragraph using a line break.
c5397bc
to
d7dc116
Compare
✅ Deploy Preview will be available once build job completes!
|
@ADubhlaoich it will be available soon, I'll tell you :) |
@@ -53,7 +55,7 @@ Open a pull request when you are ready to receive feedback from stakeholders. | |||
|
|||
After any iterative work, close the pull request. Since the closed repository is a mirror of the open one, we do not merge changes to it. | |||
|
|||
Change back to `main`, create a new branch, merge your internal branch and push to origin. | |||
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin. |
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.
This line confused me until I realized it's an overview of the commands which follow. So maybe:
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin. | |
With the following commands, check out the `main` branch, create a new branch, merge your internal branch, and push the changes to origin. |
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.
I'm confused what the value add in your edit suggestion is: the sentence is an imperative instruction telling you exactly what to do, then showing you how to do it.
In context, the instruction is juxtaposed with the exact commands to follow in the code block immediately afterwards, and there is only one thing you could possibly be pushing, so all this seems to do is add unnecessary words.
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.
The alternative is to be more precise with the commands, something like:
git checkout main
git checkout -b desired-branch-name
git merge internal/other-branch-name
git push origin main
In any case, based on @eepifanova 's suggestion in Slack, this might all become moot.
@ADubhlaoich Feel free to update documentation ^^ |
Proposed changes
Thanks to some follow up work by @eepifanova, we can now target the main branch for closed content work. This commit updates the documentation to reference the main branch, and also adds specificity of origin and remote when referencing it for clarity.
It also adds missing punctuation, and adjusts spacing in an early paragraph using a line break.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.md
Footnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩