From 9c7740b287c322608f634999fd2e07e81d34e12e Mon Sep 17 00:00:00 2001 From: Mark Linimon Date: Thu, 21 Jun 2007 04:39:45 +0000 Subject: [PATCH] Generalize this article to include information about developers who are not committers, since only a subset of the information here applies to them. To date, this has only included people who have been given GNATS access without a commit bit. The refactoring of the text is admittedly awkward, but anything else would probably be a significant rewrite. Hat: bugmeister Reviewed by: core --- .../articles/committers-guide/article.sgml | 137 +++++++++++++++--- 1 file changed, 117 insertions(+), 20 deletions(-) diff --git a/en_US.ISO8859-1/articles/committers-guide/article.sgml b/en_US.ISO8859-1/articles/committers-guide/article.sgml index 0544da8339..c1618dc346 100644 --- a/en_US.ISO8859-1/articles/committers-guide/article.sgml +++ b/en_US.ISO8859-1/articles/committers-guide/article.sgml @@ -42,6 +42,15 @@ community. All new committers should read this document before they start, and existing committers are strongly encouraged to review it from time to time. + + Almost all FreeBSD developers have commmit rights to one or + more repositories. However, a few developers do not, and some of + the information here applies to them as well. (For instance, some + people only have rights to work with the Problem Report database). + Please see for more information. + + This document may also be of interest to members of the FreeBSD + community who want to learn more about how the project works. @@ -74,6 +83,11 @@ ports/ + + &a.bugmeister; + &a.ceri; &a.linimon;, and &a.remko + + Mailing Lists &a.doc-developers;, &a.doc-committers;; @@ -731,11 +745,11 @@ alias scvs cvs -d user@ncvs.FreeBSD.org:/home/ncvs

You will almost certainly get a conflict because - of the $Id: article.sgml,v 1.263 2007-06-21 04:22:41 linimon Exp $ (or in FreeBSD's case, + of the $Id: article.sgml,v 1.264 2007-06-21 04:39:45 linimon Exp $ (or in FreeBSD's case, $FreeBSD$) lines, so you will have to edit the file to resolve the conflict - (remove the marker lines and the second $Id: article.sgml,v 1.263 2007-06-21 04:22:41 linimon Exp $ line, - leaving the original $Id: article.sgml,v 1.263 2007-06-21 04:22:41 linimon Exp $ line intact). + (remove the marker lines and the second $Id: article.sgml,v 1.264 2007-06-21 04:39:45 linimon Exp $ line, + leaving the original $Id: article.sgml,v 1.264 2007-06-21 04:39:45 linimon Exp $ line intact). @@ -1064,8 +1078,14 @@ Host pcvs.FreeBSD.org Conventions and Traditions - As a new committer there are a number of things you should do - first. + As a new developer there are a number of things you should do + first. The first set is specific to committers only. + + + Guidelines For Committers + + If you have been given commit rights to one or more of the + repositories: @@ -1138,11 +1158,31 @@ Host pcvs.FreeBSD.org - Introduce yourself to the other committers, otherwise no one + If you are subscribed to the &a.cvsall;, you will + probably want to unsubscribe to avoid receiving duplicate + copies of commit messages and their followups. + + + + All src commits should go to + &os.current; first before being merged to &os.stable;. No major + new features or high-risk modifications should be made to the + &os.stable; branch. + + + + Guidelines For Everyone + + Whether or not you have commit rights: + + + + Introduce yourself to the other developers, otherwise no one will have any idea who you are or what you are working on. You do not have to write a comprehensive biography, just write a paragraph or two about who you are and what you plan to be working on as a - committer in FreeBSD. Email this to the &a.developers; and you will + developer in FreeBSD. (You should also mention who your mentor + will be). Email this to the &a.developers; and you will be on your way! @@ -1171,31 +1211,34 @@ Host pcvs.FreeBSD.org on freefall.FreeBSD.org to disable the checks for your email. - - - If you are subscribed to the &a.cvsall;, you will - probably want to unsubscribe to avoid receiving duplicate - copies of commit messages and their followups. - - All src commits should go to - &os.current; first before being merged to &os.stable;. No major - new features or high-risk modifications should be made to the - &os.stable; branch. + + If you are a developer but not a committer, you will + not be subscribed to the committers or developers mailing lists; + the subscriptions are derived from the access rights. + + - All new committers also have a mentor assigned to them for + + Mentors + + All new developers also have a mentor assigned to them for the first few months. Your mentor is responsible for teaching you the rules and conventions of the project and guiding your - first steps in the committer community. He or she is also + first steps in the developer community. He or she is also personally responsible for your actions during this initial - period. Until your mentor decides (and announces with a forced + period. + + For committers: until your + mentor decides (and announces with a forced commit to access) that you have learned the ropes and are ready to commit on your own, you should not commit anything without first getting your mentor's review and approval, and you should document that approval with an Approved by: line in the commit message. + @@ -3070,6 +3113,60 @@ bak/packages packages from last complete <major_version> run on <arch& + + Issues Specific To Developers Who Are Not Committers + + A few people who have access to the FreeBSD machines do not + have commit bits. For instance, the project is willing to give + access to the GNATS database to contributors who have shown interest + and dedication in working on Problem Reports. + + Almost all of this document will apply to these developers as + well (except things specific to CVS commits and the mailing list + memberships that go with them). In particular, we recommend that + you read: + + + + + Administrative Details + + + + + + Conventions + + + + You should get your mentor to add you to the + Additional Contributors + (doc/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml), + if you are not already listed there. + + + + + + Developer Relations + + + + + + SSH Quick-Start Guide + + + + + + The FreeBSD Committers' Big List of Rules + + + + + + Perks of the Job