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.

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

Docs: Add clarification about git workflow #13534

Merged
merged 8 commits into from
Jan 31, 2019
Merged

Docs: Add clarification about git workflow #13534

merged 8 commits into from
Jan 31, 2019

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Jan 28, 2019

Description

In #12747 (comment) @kadencethemes asked about clarification what does rebasing PRs mean:

I'm not very familiar with what "rebase this PR" means. Could you tell me what I need to do?

This PR adds new section to docs which tries to explain it. It might be not perfect so I would appreciate your feedback to make it even simpler to understand.

I also updated Repository Management page to include the step about keeping branches up to date with master branch.

@gziolo gziolo self-assigned this Jan 28, 2019
@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Jan 28, 2019
@gziolo gziolo added this to the Documentation & Handbook milestone Jan 28, 2019
@gziolo gziolo requested review from a team, ajitbohra and chrisvanpatten January 28, 2019 10:55
@gziolo gziolo mentioned this pull request Jan 28, 2019
4 tasks
@chrisvanpatten
Copy link
Contributor

I’m OOO today but did a quick scan and it looks great to me. Admittedly I’m a merge from master guy (I like having the history of where I merged) but I think rebasing is more commonly preferred and it’s reasonable to encourage that!

Copy link
Contributor

@mcsf mcsf left a comment

Choose a reason for hiding this comment

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

Looks great, though I suggested a bunch of things.

docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
@ajitbohra
Copy link
Member

@gziolo i am that merge guy :D

With all sugegstions so far looks good 👍

as mentioned by @talldan it would be good to cover syncing fork https://help.github.com/articles/syncing-a-fork/ we can either adopt this or link it

We can add some resources / links for further references:

@gziolo
Copy link
Member Author

gziolo commented Jan 29, 2019

@ajitbohra great idea about adding a section with references. Feel free to add your commit with the changes proposed.

@mcsf - your changes looks great, many thanks for helping to make it more friendly for those who start digging into git world.

@mcsf
Copy link
Contributor

mcsf commented Jan 29, 2019

We can add some resources / links for further references:

Pro Git is such a great resource—at least the v1 was when I read it back in the day. 👌 Might be more useful to point to the online book rather than the repo, no?

https://git-scm.com/book/en/v2

@ajitbohra
Copy link
Member

yes link to online book 💯

@ajitbohra
Copy link
Member

ajitbohra commented Jan 29, 2019

Added references and section to work with fork.

@gziolo
Copy link
Member Author

gziolo commented Jan 31, 2019

Nice teamwork, thanks everyone for feedback, commits and sharing great ideas. Is it good to merge as is? I can't accept my own PR, so I'm waiting for ✅ before I proceed further :)

Copy link
Member

@ntwb ntwb left a comment

Choose a reason for hiding this comment

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

It looks good to me :shipit:

@gziolo gziolo merged commit 6e4e9aa into master Jan 31, 2019
@gziolo gziolo deleted the docs/git-workflow branch January 31, 2019 10:24
daniloercoli added a commit that referenced this pull request Feb 1, 2019
…rnmobile/372-use-RichText-on-Title-block

* 'master' of https://github.com/WordPress/gutenberg:
  Try alternate list item jump fix. (#12941)
  Mobile bottom sheet component (#13612)
  Remove unintentional right-margin on last odd-item. (#12199)
  Introduce left and right float alignment options to latest posts block (#8814)
  Fix Google Docs table paste (#13543)
  Increase bottom padding on gallery image caption (#13623)
  Fix the editor save keyboard shortcut not working in code editor view (#13159)
  Plugin: Deprecate gutenberg_add_admin_body_class (#13572)
  Rnmobile/upload media failed state (#13615)
  Make clickOnMoreMenuItem not dependent on aria labels (#13166)
  Add: className prop support to server side render. (#13568)
  Fix: Categories Block: hierarchical Dropdown (#13567)
  Docs: Add clarification about git workflow (#13534)
  Plugin: Remove `user_can_richedit` filtering (#13608)
  eslint-plugin: Add rule `no-unused-vars-before-return` (#12828)
  Image settings button (#13597)
  Fixed wording for the color picker saturation (#13479)

# Conflicts:
#	packages/block-library/src/image/edit.native.js
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Add clarification about git workflow

* Update git-workflow.md

* Update git-workflow.md

* Reword paragraph on merging vs. rebasing

* Add references

* Add fork section

* Clarify link to section "Perform a rebase"

* Apply suggestions from code review

Co-Authored-By: gziolo <[email protected]>
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Add clarification about git workflow

* Update git-workflow.md

* Update git-workflow.md

* Reword paragraph on merging vs. rebasing

* Add references

* Add fork section

* Clarify link to section "Perform a rebase"

* Apply suggestions from code review

Co-Authored-By: gziolo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants