From 8bad7dc99d004a3671416d6ed5edd7d4033a4f2c Mon Sep 17 00:00:00 2001 From: Piotr Mitros Date: Mon, 18 Jun 2012 17:06:17 -0400 Subject: [PATCH 1/3] Code standards --- doc/code_standards.txt | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/code_standards.txt b/doc/code_standards.txt index 02953b3677..06be87fd6a 100644 --- a/doc/code_standards.txt +++ b/doc/code_standards.txt @@ -75,7 +75,21 @@ no hard standards. review it (this may change as the team grows). * Each contributor is responsible for finding a person to review their code. If it is not clear to the contributor who is appropriate, each - project has an owner + project has an owner who is the default go-to. + +2.1 Rapid pull + +Unmerged code can lead to merge conflicts, and slow down +development. We have an experimental procedure for handling rapid +pulls and merges. To qualify: + +* A piece of code must only have minor issues remaining (nothing which +we would be uncomfortable placing on a server). +* Either the requester or the puller takes ownership for guaranteeing +that those issues are resolved within a short timeframe. +* Both the requester and the puller must be comfortable with it. + +If code qualified, it can be merged, and repaired in master. 3. Documentation Standards From e108c2cd4421b5b20cfd6ebcbeb8d2e1c2fa5aaa Mon Sep 17 00:00:00 2001 From: Piotr Mitros Date: Mon, 18 Jun 2012 17:09:17 -0400 Subject: [PATCH 2/3] Rapid pull/history --- doc/code_standards.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/code_standards.txt b/doc/code_standards.txt index 06be87fd6a..33ec4cecab 100644 --- a/doc/code_standards.txt +++ b/doc/code_standards.txt @@ -88,6 +88,8 @@ we would be uncomfortable placing on a server). * Either the requester or the puller takes ownership for guaranteeing that those issues are resolved within a short timeframe. * Both the requester and the puller must be comfortable with it. +* Both the requester and the owner must have a history of/ability to +resolve remaining issues quickly. If code qualified, it can be merged, and repaired in master. From 25834412ce23e2c5cd77bea4001f1df5ee798cf0 Mon Sep 17 00:00:00 2001 From: Piotr Mitros Date: Mon, 18 Jun 2012 17:40:39 -0400 Subject: [PATCH 3/3] Documentation for rapid merge --- doc/code_standards.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/code_standards.txt b/doc/code_standards.txt index 33ec4cecab..a4833b8d36 100644 --- a/doc/code_standards.txt +++ b/doc/code_standards.txt @@ -84,14 +84,22 @@ development. We have an experimental procedure for handling rapid pulls and merges. To qualify: * A piece of code must only have minor issues remaining (nothing which -we would be uncomfortable placing on a server). + we would be uncomfortable placing on a server). * Either the requester or the puller takes ownership for guaranteeing -that those issues are resolved within a short timeframe. + that those issues are resolved within a short timeframe. * Both the requester and the puller must be comfortable with it. * Both the requester and the owner must have a history of/ability to -resolve remaining issues quickly. + resolve remaining issues quickly. -If code qualified, it can be merged, and repaired in master. +If code qualifies: +* It can be merged, and repaired in master. +* The pull message should specify '## pending fixes/OWNER' where ## is + the pull request number, and OWNER is the owner. +* All required fixes are documented in github in the (now closed) pull + request, and should be marked off there when applied (potentially, + directly to master). +* Once all fixes are applied, the final commit should specify + '## closed'. 3. Documentation Standards