Page MenuHomePhabricator

Add/update some documentation on branches and reviewable code
ClosedPublic

Authored by epriestley on Jul 20 2012, 8:44 PM.
Tags
None
Referenced Files
F13817994: D3025.diff
Fri, Sep 20, 4:42 AM
Unknown Object (File)
Sat, Sep 14, 4:08 PM
Unknown Object (File)
Sat, Sep 14, 4:08 PM
Unknown Object (File)
Sat, Sep 14, 4:07 PM
Unknown Object (File)
Sat, Sep 14, 4:07 PM
Unknown Object (File)
Sat, Sep 14, 4:07 PM
Unknown Object (File)
Sat, Sep 7, 4:43 PM
Unknown Object (File)
Tue, Sep 3, 5:09 AM
Subscribers

Details

Summary
  • The most common workflow complaint I've seen recently is something like "how do I use Differential with a branch full of random code that me and several other developers all commit to"? There are some okay answers ("commandeer") but I think the best answer is "don't do that". Add a document explaining how development works at Facebook (and many other companies) without the use of feature branching, why it's better, and how you can lay the technical groundwork you need to to stop doing this.
  • Add a general "smaller commits are better" and "your commit messsage should provide context" document.
  • Minor updates to other stuff as my understanding of Mercurial has been refined.
Test Plan

Generated and read documentation.

Diff Detail

Branch
docs
Lint
Lint Passed
Unit
No Test Coverage

Event Timeline

src/docs/flavortext/writing_reviewable_code.diviner
74โ€“75

(I thought this was a pretty cool stat, although I'm not sure how well we're doing relative to other projects.)

this is awesome and i love the median checkin stat.

I'm wiped out (just closed out the strata apartment, which meant moving shit to sister Melissa's place up many flights in the mission and sister-in-law's stuff to my house). I want to give this a good read / feedback since I think its a pretty important / awesome article. That'll maybe be later today if I recoup well and if not tomorrow.

btrahan added inline comments.
src/docs/flavortext/recommendations_on_branching.diviner
102

s/being/begin

maybe "You don't need this in the beginning. For example, before Gatekeeper,..."

src/docs/flavortext/writing_reviewable_code.diviner
64

I love this paragraph.

src/docs/flavortext/recommendations_on_branching.diviner
49

I would use this in Czenglish:

percentage of users
only for employees

99

The tool itself uses camel case: GateKeeper.

106โ€“115

Wrapping.

115

Once

133

100+ ms

153

"a some projects" -> "some projects"

179

Add newline.

epriestley updated this revision to Unknown Object (????).Jul 23 2012, 5:21 PM

Address feedback, thanks!

epriestley changed the visibility from "All Users" to "Public (No Login Required)".