Mod+Wheel Window Resize
[wmaker-crm.git] / The-perfect-Window-Maker-patch.txt
blob1d2e44551d514e7d500166721211bf037d12a3db
1 ____________
2 Introduction
3 ------------
5 This short tutorial is meant to help you help me in the task
6 of having a maintainable and bug-free Window Maker.
8 It assumes you have 'git' correctly installed and you have set
9 the most basic configuration options via 'git config' (or by
10 editing the $HOME/.gitconfig file yourself). See the end
11 of this file for an example .gitconfig (which is the one
12 I use).
14 You should probably by now have already cloned my repository,
15 but here is how you can do it just in case:
17 # this is the preferred method (ie faster, native implementation)
18 git clone git://repo.or.cz/wmaker-crm.git
20 # use the http method only if are behind a firewall which blocks git://
21 git clone http://repo.or.cz/r/wmaker-crm.git
23 __________________________________
24 How to submit patches the git way
25 ----------------------------------
27 Suppose you have a working copy of the git repo and you found
28 a bug in Window Maker and you know how to fix it. This is
29 what you can do to submit your patch in a way which will allow
30 me to apply it quickly.
32 # Optional: Create a new branch (just to be safe in case you screw up)
33 git checkout -b my-new-branch
35 Now you edit and save the files to fix the bug...
37 # Optional: Check what you did, review etc
38 git diff
40 # if it looks good, commit your changes
41 git commit -a
43 # git will pop up the editor which you configured in .gitconfig so
44 # that you will be able to write a commit log. It will use the 'vi'
45 # editor otherwise.
47 (write a _good_ and succinct commit log, explaining what you fixed etc)
49 # Prepare the patch to submit to the mailing-list. This step will create
50 # a file named 0001-subject-of-your-patch.patch from the last commit
51 # (use HEAD~2 if you want patches for the last 2 commits etc)
52 git format-patch HEAD~1
54 After the above steps, you are ready to send the created .patch file
55 to the mailing-list! Just send it as-is, and I will be able to apply
56 it with
58 # this is how I am going to apply your patch
59 git am 0001-subject-of-your-patch.patch
61 and it will automatically append your commit to the repo, with the
62 proper authorship, date, subject, commit log etc.
64 ___________________
65 Example .gitconfig
66 -------------------
68 [user]
69         name = Erwin Schrodinger
70         email = schrodinger@gmail.com
71 [core]
72         editor = xjed
73 [status]
74         showUntrackedFiles = no
75 [color]
76         branch = auto
77         status = auto
78         diff = auto
79         ui = auto
80 [apply]
81         whitespace = fix
82