Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Create section: branch renaming #1476

Merged
merged 13 commits into from
Aug 16, 2020
Merged

Create section: branch renaming #1476

merged 13 commits into from
Aug 16, 2020

Conversation

HonkingGoose
Copy link
Contributor

@HonkingGoose HonkingGoose commented Aug 8, 2020 •
edited
Loading

Add a new section dealing with renaming branches containing:

  • Heading: "Changing a branch name"
  • Subheading: "Changing the master branch name".
  • The command to change the branch name.
  • A big [WARNING] message, so that users are not going to change their master branch willy-nilly.
  • Give advice on the things that will need to be updated after changing the default branch.

This is a rough draft, and will need some feedback to get it ready for merging.
I also think some other files will need to be changed as well, so that it's all properly referencing each other. I'm really not sure where those references should be. So I could use some help with that. 😄

This PR will help with issue: #1462

@HonkingGoose HonkingGoose changed the title Create section branch renaming Create section: branch renaming Aug 8, 2020
ben
ben reviewed Aug 9, 2020
View reviewed changes
Copy link
Member

@ben ben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the direction you've got here, and it doesn't feel like it's very far from being done.

book/03-git-branching/sections/branch-management.asc Outdated Show resolved Hide resolved
book/03-git-branching/sections/branch-management.asc Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Contributor Author

HonkingGoose commented Aug 10, 2020 •
edited
Loading

Hi @ben,

I noticed I merged in other work by accident on my push with newer stuff, I'll go fix that now...
EDIT: fixed now.

Man writing technical docs is hard... especially for something as complicated as changing the master branch.
I did some more work on the text, hopefully this is better than what we had just before. I still have some questions though.

Should we include links to GitHub documentation, for things like:

Should we mention things like Dependabot/Travis CI by name, to help users understand what kind of things might break?

Maybe we should instruct readers to merge or close all pending pull requests that are targeting master before making the move. As this will save a lot of headaches when trying to merge the pull-request via the GitHub/Gitlab interface. (I tried re-targeting pulls that targeted the old master branch, this was less of a hassle than I anticipated when writing this text...)

Do we want a vendor neutral text, or do we want to mention GitHub specific gotchas?

HonkingGoose

HonkingGoose and others added 10 commits August 10, 2020 15:00
@HonkingGoose
Create section: branch renaming
3680ec7
@HonkingGoose @ben
Apply suggestions from code review
c6e58ba 
- Remove unnecessary comma
- Explain what happens what the result is after changing your branch name and pushing the changed branch to the remote

Co-authored-by: Ben Straub <[email protected]>
@HonkingGoose
Expand basic branch renaming section
9af27d4
@HonkingGoose
Expand renaming master branch section
c5377f4
@HonkingGoose
Move caution to top of section
557fbf1 
- Warn about changing the mainline branch.
@HonkingGoose
Use . instead of ?
ae00df2
@HonkingGoose
Refine text further
6a6fb43
@HonkingGoose
Expand master branch change section:
a4dee15 
- Add item to list
- Explain how to remove the master branch
@HonkingGoose
Remove double :
ac55505
@ben
Merge branch 'master' into feature/add-section-change-existing-branch…
eea47f3 
…-name
ben
ben reviewed Aug 16, 2020
View reviewed changes
Copy link
Member

@ben ben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super close, just a couple more suggestions.

book/03-git-branching/sections/branch-management.asc Outdated Show resolved Hide resolved
book/03-git-branching/sections/branch-management.asc Outdated Show resolved Hide resolved
HonkingGoose and others added 2 commits August 16, 2020 09:02
@HonkingGoose HonkingGoose marked this pull request as ready for review August 16, 2020 07:04
@HonkingGoose
Copy link
Contributor Author

Ready for review and possibly a merge.

@ben ben merged commit d7f7429 into progit:master Aug 16, 2020
@HonkingGoose HonkingGoose deleted the feature/add-section-change-existing-branch-name branch August 16, 2020 20:27
@HonkingGoose HonkingGoose mentioned this pull request Aug 17, 2020
Closed
@HonkingGoose HonkingGoose mentioned this pull request Aug 28, 2020
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ben ben ben left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@HonkingGoose @ben