Skip to content

Fixing wrong wording for source branch #24

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

Merged
merged 2 commits into from
Jan 31, 2020
Merged

Conversation

daniel-sc
Copy link
Contributor

No description provided.

@daniel-sc daniel-sc requested a review from bast January 31, 2020 06:31
Copy link
Collaborator

@robertodr robertodr left a comment

Choose a reason for hiding this comment

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

Thanks for your PR. I agree that the wording here is confusing and should be changed. We meant that whereas you need to have the PR from any fork based off the target branch, you should commit your work to a separate branch, as to avoid the scenario documented here

This is what we had in mind. Say you are working on a new feature that should land on master:

  1. You create a fork of the canonical repo.
  2. You branch off of master the branch new-feature.
  3. Commit to new-feature and push.
  4. Open a PR. This will target canonical:master from your-fork:new-feature rather than being canonical:master from your-fork:master.

@daniel-sc
Copy link
Contributor Author

I understand, probably one should clarify that

  1. The new branch should start off from the target branch.
  2. The naming of the new branch should follow feature/issue branch naming conventions.

Would this distinction bewteen naming and starting point resolve this ambiguity?

@robertodr
Copy link
Collaborator

Yes, that would do it, in conjunction with a link to that blog posts which explains why creating a new branch is a good idea.

@daniel-sc daniel-sc requested a review from robertodr January 31, 2020 07:36
Copy link
Collaborator

@robertodr robertodr left a comment

Choose a reason for hiding this comment

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

Thank you! Waiting for @bast to also read through the change before merging.

@bast
Copy link
Member

bast commented Jan 31, 2020

Thanks so much!

@bast bast merged commit 51a4700 into dev-cafe:gh-pages Jan 31, 2020
@daniel-sc daniel-sc deleted the patch-1 branch January 31, 2020 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants