diff --git a/collects/scribblings/style/branch-and-commit.scrbl b/collects/scribblings/style/branch-and-commit.scrbl index ad866f181e..86e2b7486e 100644 --- a/collects/scribblings/style/branch-and-commit.scrbl +++ b/collects/scribblings/style/branch-and-commit.scrbl @@ -2,12 +2,26 @@ @(require "shared.rkt") -@title[#:tag "branch-and-commit"]{Branch and Commit} +@title[#:tag "branch-and-commit"]{Retiquette: Branch and Commit} -Working with the code base also requires style rules for actions on the + This section is specifically for Racketeers who commit to the Racket code + base. + + Working with the bug database requires one critical work flow rule. + + Working with the code base requires style rules for actions on the repository. Currently we are using Git and below are a few rules on how to act in this context. +@;----------------------------------------------------------------------------- +@section{Bugfix Workflow} + +Re-assign bug reports only after you can eliminate your own code as the source + of a bug. The best way to accomplish this goal is to create a new example that + re-creates the problem without involvement of your code. When you have such a + code snippet, re-assign the code to the person responsible for the apparently + buggy component and submit the code snippet as part of the justification. + @; ----------------------------------------------------------------------------- @section{Commit} @@ -73,7 +87,7 @@ fork: @item{setup mail notifications: @verbatim{ ssh pltgit config set eli/my-plt hooks.counter true - ssh pltgit config set eli/my-plt hooks.mailinglist "eli@barzilay.org,..."}} + ssh pltgit config set eli/my-plt hooks.mailinglist @eli,...}} @item{allow someone else to push commits to my repository: @verbatim{ diff --git a/collects/scribblings/style/shared.rkt b/collects/scribblings/style/shared.rkt index ac2340f603..87e6467f28 100644 --- a/collects/scribblings/style/shared.rkt +++ b/collects/scribblings/style/shared.rkt @@ -16,6 +16,7 @@ (provide LINEWIDTH + eli codebox compare ;; create a comparison box for two code snippets ;; good ;; label a code fragment 'good' [doesn't work] @@ -24,6 +25,8 @@ row-table rkt rkt/base rkt/gui xml) +(define eli "eli@barzilay.org") + (define (LINEWIDTH) "102") ;; --------------------------------------------------------------------------------------------------- @@ -33,6 +36,7 @@ (define (rkt/gui) (racketmodname racket/gui)) (define (xml) (racketmodname xml)) + ;; compare: two code snippets, in two columns: left is good, right is bad (define (compare stuff1 stuff2) (define stuff (list (list stuff1) (list stuff2)))