nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

hacking-howto: refer people to cr.i3wm.org

This commit is contained in:
Michael Stapelberg 2013-02-10 15:10:13 +01:00
parent a1774e78fc
commit d36e2a70bf
1 changed files with 13 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/hacking-howto
View File

@ -1,7 +1,7 @@
Hacking i3: How To
==================
Michael Stapelberg <michael+i3@stapelberg.de>
July 2011
Michael Stapelberg <michael@i3wm.org>
February 2013
This document is intended to be the first thing you read before looking and/or
touching i3’s source code. It should contain all important information to help
@ -947,32 +947,20 @@ For a short introduction into using git, see
http://www.spheredev.org/wiki/Git_for_the_lazy or, for more documentation, see
http://git-scm.com/documentation
When you want to send a patch because you fixed a bug or implemented a cool
feature (please talk to us before working on features to see whether they are
maybe already implemented, not possible for some some reason, or don’t fit
into the concept), please use git to create a patchfile.
Please talk to us before working on new features to see whether they will be
accepted. There are a few things which we don’t want to see in i3, e.g. a
command which will focus windows in an alt+tab like way.
First of all, update your working copy to the latest version of the master
branch:
When working on bugfixes, please make sure you mention that you are working on
it in the corresponding bugreport at http://bugs.i3wm.org/. In case there is no
bugreport yet, please create one.
--------
git pull
--------
After you are done, please submit your work for review at http://cr.i3wm.org/
Afterwards, make the necessary changes for your bugfix/feature. Then, review
the changes using +git diff+ (you might want to enable colors in the diff using
+git config diff.color auto+). When you are definitely done, use +git commit
-a+ to commit all changes you’ve made.
Then, use the following command to generate a patchfile which we can directly
apply to the branch, preserving your commit message and name:
-----------------------
git format-patch origin
-----------------------
Just send the generated file via email to the i3-discuss mailing list, see
http://i3wm.org/contact/
Do not send emails to the mailing list or any author directly, and don’t submit
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.
== Thought experiments