HACKING 3.09 KB
Newer Older
1 2
Source code repository
======================
Chema Celorio's avatar
add  
Chema Celorio committed
3

4 5 6 7 8 9 10 11 12 13 14 15 16
gedit source code is maintained using the git version control system
and is available at the following location:

    git://git.gnome.org/gedit

Or if you have an account on GNOME servers:

    ssh://USERNAME@git.gnome.org/git/gedit

A Web Interface is available at:

    http://git.gnome.org/cgit/gedit

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

Building from git
=================

When building from a git checkout you will need to run the
autogen.sh script which takes care of running automake, autoconf,
etc and then run "configure" for you. You can pass options like
--prefix to autogen.sh and they will be forwarded to the configure
script.

Note that you cannot run gedit from its build directory: you need
to install it with "make install". For this reason it is highly
recommended that you install in a separate prefix instead of
overwriting your system binaries. Note however that when running
gedit from a custom prefix you will need to set many environment
variables accordingly, for instance PATH and XDG_DATA_DIR.
The JHBuild tool can take care of all this for you.


Commit guidelines
=================

39
Please don't commit directly to the git repository unless
40 41
you have been given the green light to commit freely to gedit. 
When in doubt assume you haven't ;-).
Chema Celorio's avatar
add  
Chema Celorio committed
42

43 44
Please attach patches in bugzilla (http://bugzilla.gnome.org).
If the patch fixes a bug that is not reported yet in bugzilla or is
Paolo Maggi's avatar
Paolo Maggi committed
45
an enhancement, create a new bugreport.
Chema Celorio's avatar
add  
Chema Celorio committed
46 47

If you are a translator feel free to mark strings for translation,
Paolo Maggi's avatar
Paolo Maggi committed
48
fix typos in the code, etc.
Chema Celorio's avatar
add  
Chema Celorio committed
49

50 51
Please send patches for build & configure fixes too.  I really appreciate
your help, I just want to review these fixes before applying.
Chema Celorio's avatar
add  
Chema Celorio committed
52

53
If you are a "build sheriff", feel free to commit fixes for build and 
Paolo Maggi's avatar
Paolo Maggi committed
54 55
configure (please, send me an e-mail with the patch you have applied).

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
When committing to the gedit git repository make sure to include a
meaningful commit message. Changes without a sufficient commit message
will be reverted. Commit messages should have the following format:

=== begin example commit ===
Short explanation of the commit

Longer explanation explaining exactly what's changed, whether any
external or private interfaces changed, what bugs were fixed (with bug
tracker reference if applicable) and so forth. Be concise but not too brief.
=== end example commit ===

  - Always add a brief description of the commit to the _first_ line of
    the commit and terminate by two newlines (it will work without the
    second newline, but that is not nice for the interfaces).

  - First line (the brief description) must only be one sentence and
    should start with a capital letter unless it starts with a lowercase
    symbol or identifier. Don't use a trailing period either. Don't exceed
    72 characters.

  - The main description (the body) is normal prose and should use normal
    punctuation and capital letters where appropriate. Normally, for patches
    sent to a mailing list it's copied from there.

  - When committing code on behalf of others use the --author option, e.g.
    git commit -a --author "Joe Coder <joe@coder.org>" and --signoff.


Thanks,

  The gedit team.