docs/hacking-howto: explain our different branches

This commit is contained in:
Michael Stapelberg 2013-03-14 14:44:01 +01:00
parent fee6d15a3a
commit 0f6d483558
1 changed files with 13 additions and 0 deletions

View File

@ -944,6 +944,8 @@ Without much ado, here is the list of cases which need to be considered:
== Using git / sending patches == Using git / sending patches
=== Introduction
For a short introduction into using git, see For a short introduction into using git, see
http://web.archive.org/web/20121024222556/http://www.spheredev.org/wiki/Git_for_the_lazy 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 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 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. 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 == Thought experiments
In this section, we collect thought experiments, so that we dont forget our In this section, we collect thought experiments, so that we dont forget our