From 0f6d48355816544970e436ad15ca74759d41326d Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Thu, 14 Mar 2013 14:44:01 +0100 Subject: [PATCH] docs/hacking-howto: explain our different branches --- docs/hacking-howto | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/hacking-howto b/docs/hacking-howto index aecbfa43..c601bf9a 100644 --- a/docs/hacking-howto +++ b/docs/hacking-howto @@ -944,6 +944,8 @@ Without much ado, here is the list of cases which need to be considered: == Using git / sending patches +=== Introduction + For a short introduction into using git, see http://web.archive.org/web/20121024222556/http://www.spheredev.org/wiki/Git_for_the_lazy or, for more documentation, see http://git-scm.com/documentation @@ -963,6 +965,17 @@ them in the bugtracker, since all reviews should be done in public at http://cr.i3wm.org/. In order to make your review go as fast as possible, you could have a look at previous reviews and see what the common mistakes are. +=== Which branch to use? + +Work on i3 generally happens in two branches: “master” and “next”. Since +“master” is what people get when they check out the git repository, its +contents are always stable. That is, it contains the source code of the latest +release, plus any bugfixes that were applied since that release. + +New features are only found in the “next” branch. Therefore, if you are working +on a new feature, use the “next” branch. If you are working on a bugfix, use +the “next” branch, too, but make sure your code also works on “master”. + == Thought experiments In this section, we collect thought experiments, so that we don’t forget our