[gtksourceview/gtksourcecompletion] Update HACKING file for git
- From: Paolo Borelli <pborelli src gnome org>
- To: svn-commits-list gnome org
- Subject: [gtksourceview/gtksourcecompletion] Update HACKING file for git
- Date: Sat, 2 May 2009 11:46:40 -0400 (EDT)
commit 17ea29d36a83d5f6ab7fcae6663964871641f7ab
Author: Paolo Borelli <porelli gnome org>
Date: Sat May 2 17:31:13 2009 +0200
Update HACKING file for git
---
HACKING | 74 ++++++++++++++++++++++++++++++++++++++++----------------------
1 files changed, 48 insertions(+), 26 deletions(-)
diff --git a/HACKING b/HACKING
index 6a7e45f..254ab8e 100644
--- a/HACKING
+++ b/HACKING
@@ -1,44 +1,66 @@
-Coding Style
-============
+guidelines for GtkSourceView
+============================
-All new code in GtkSourceView should follow the GNOME Programming Guidelines
-(http://developer.gnome.org/doc/guides/programming-guidelines/), except
-braces for which we prefer the "hanging" style. I.e.:
+gtksourceview source code is maintained using the git version control system
+and is available at the following location:
- if (x)
- {
- code_block;
- }
+ git://git.gnome.org/gtksourceview
-Braces are optional if code_block is just one line of code, but be
-consistent for multiple branched statements suchs as if/else if/else.
+Or if you have an account on GNOME servers:
-If you add new API to GtkSourceView you must provide gtk-doc style
-comments fully documenting all the functions you're adding.
+ ssh://USERNAME git gnome org/git/gtksourceview
-Subversion guidelines for gtksourceview
-=======================================
+A Web Interface is available at:
-Please don't commit directly to the subversion repository unless you have
-been given the green light to commit freely to gtksourceview.
-When in doubt assume you haven't ;-).
+ http://git.gnome.org/cgit/gtksourceview
-Please submit patches to bugzilla.gnome.org. We will review
-them with much pleasure.
+Please don't commit directly to the git repository unless
+you have been given the green light to commit freely to gtksourceview.
+When in doubt assume you haven't ;-).
+
+Please attach patches in bugzilla (http://bugzilla.gnome.org).
+If the patch fixes a bug that is not reported yet in bugzilla or is
+an enhancement, create a new bugreport.
If you are a translator feel free to mark strings for translation,
fix typos in the code, etc.
-Please send patches for build & configure fixes too.
-
-We really appreciate your help, we just want to review these fixes
-before applying.
+Please send patches for build & configure fixes too. I really appreciate
+your help, I just want to review these fixes before applying.
If you are a "build sheriff", feel free to commit fixes for build and
-configure (please, send us an e-mail with the patch you have applied).
+configure (please, send me an e-mail with the patch you have applied).
+
+When committing to the gtksourceview 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 GtkSourceView team
+ The GtkSourceView team.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]