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
F13989921: D3025.id5751.diff
Mon, Oct 21, 11:56 PM
F13977045: D3025.id5774.diff
Fri, Oct 18, 4:51 PM
F13963538: D3025.diff
Tue, Oct 15, 4:29 PM
Unknown Object (File)
Sep 20 2024, 6:27 AM
Unknown Object (File)
Sep 20 2024, 4:42 AM
Unknown Object (File)
Sep 14 2024, 4:08 PM
Unknown Object (File)
Sep 14 2024, 4:08 PM
Unknown Object (File)
Sep 14 2024, 4:07 PM
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
75–76

(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
103

s/being/begin

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

src/docs/flavortext/writing_reviewable_code.diviner
65

I love this paragraph.

src/docs/flavortext/recommendations_on_branching.diviner
50

I would use this in Czenglish:

percentage of users
only for employees

100

The tool itself uses camel case: GateKeeper.

107–116

Wrapping.

116

Once

134

100+ ms

154

"a some projects" -> "some projects"

189

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)".