This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mention why it's a good idea to use topic branches for everything
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Tue, 16 Feb 2010 18:19:18 +0000 (18:19 +0000)
committerÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Tue, 16 Feb 2010 18:19:18 +0000 (18:19 +0000)
Most of this is derived from Dan Golden's E-Mail to me on
perl5-porters with the subject "[PATCH] Add comments to gv.c about
variable implementation" where I'd submitted a patch without using a
topic branch.

pod/perlrepository.pod

index af2229d..2f29aef 100644 (file)
@@ -299,6 +299,14 @@ which is the short form of
   % git branch orange
   % git checkout orange
 
   % git branch orange
   % git checkout orange
 
+Creating a topic branch makes it easier for the maintainers to rebase
+or merge back into the master blead for a more linear history. If you
+don't work on a topic branch the maintainer has to manually cherry
+pick your changes onto blead before they can be applied.
+
+That'll get you scolded on perl5-porters, so don't do that. Be
+Awesome.
+
 Then make your changes. For example, if Leon Brocard changes his name
 to Orange Brocard, we should change his name in the AUTHORS file:
 
 Then make your changes. For example, if Leon Brocard changes his name
 to Orange Brocard, we should change his name in the AUTHORS file: