Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Improve docs for github pull workflow #17

Closed
fwenzel opened this Issue Feb 17, 2012 · 4 comments

Comments

Projects
None yet
4 participants
Member

fwenzel commented Feb 17, 2012

Currently, in terms of github workflow we have this:

http://mozweb.readthedocs.org/en/latest/git.html#working-on-projects

I think two things are missing:

  1. A slightly more elaborate explanation of these steps and/or weblinks with more information. The goal is to be able to point people (contractors, perhaps) at this and they should know how to get their code reviewed on an ongoing basis.
  2. There's no mention of rebasing/squashing commits before sending a pull request or landing it. There are different opinions on this, so we shouldn't go straight for the strictest option, but "squash your list of commits down to a few commits" or so is probably an agreeable opinion across webdev.

@ghost ghost assigned pmclanahan Feb 17, 2012

Member

tofumatt commented Feb 17, 2012

Actually, line 53 in git.rst does address point 2 kinda and there are a bunch of links in that git file to really awesome git resources, but I think we could stand to be clearer about how/why we rebase.

Member

davedash commented Feb 17, 2012

Specifically squash your commits into atomic commits. And then give examples:

Added a new handler method
Removed handler method
Delete a directory
Wrote content
Fixed a typo in last commit
Added a new contenttype

This is a bad git log ^^^

a better one is all that squashed into three atomic items, we care about net results

Deleted a directory
Wrote content
Added new contenttype

We want

  1. Atomic commits
  2. The net results of what you did
  3. Tests, docs, code all together
  4. Submit perfect commits to master, leave you're trials in tribulations behind in a personal branch.

@ghost ghost assigned tofumatt Feb 17, 2012

Member

tofumatt commented Feb 17, 2012

Holy shit that was helpful. I'll integrate that into the docs and push it.

Member

tofumatt commented Jan 20, 2016

Oh, yeah, seems I closed this ages ago.

@tofumatt tofumatt closed this Jan 20, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment