summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2008-06-05 20:05:39 (GMT)
committerColin Walters <walters@verbum.org>2008-06-05 20:05:39 (GMT)
commit8054025ae498cc586676fd0ed6573828dd0de4a0 (patch)
treef2b69f21b194c5f3601d5fca658476fc82a4f816
parentd80bc7686a0e5cc7d45d940e8404ac4c8742b8f5 (diff)
downloaddbus-glib-8054025ae498cc586676fd0ed6573828dd0de4a0.tar.gz
dbus-glib-8054025ae498cc586676fd0ed6573828dd0de4a0.tar.xz
One final large HACKING update
-rw-r--r--HACKING32
1 files changed, 29 insertions, 3 deletions
diff --git a/HACKING b/HACKING
index c07c61f..76a4d3e 100644
--- a/HACKING
+++ b/HACKING
@@ -1,15 +1,18 @@
The mainline git tree for this code is at
git://anongit.freedesktop.org/git/dbus/dbus-glib.
-if you are making major changes which you wish to be incorporated upstream,
+= Creating changes =
+
+Be sure to match the existing code style (Emacs: "gnu").
+
+If you are making major changes which you wish to be incorporated upstream,
please do as small commits to your local git tree, so there is a good
history of your changes.
-When you consider changes ready for merging to mainline, either use
+When you consider changes ready for merging to mainline, use
"git-format-patch" or otherwise generate diffs. Post those diffs
to a new bug at http://bugs.freedesktop.org, project DBus, component GLib.
-= Testing =
For nontrivial changes *please* try to extend the test suite to cover it. The
test infrastructure is in test/core/, and currently there are a lot of tests
in the single file test/core/test-dbus-glib.c. Extending this file is
@@ -17,6 +20,29 @@ suggested (in the future we would like to break this file up).
Run "make check" to run the test suite.
+= Committing =
+
+If applying a patch from someone else that created them via
+"git-format-patch", you can use "git-am -s" to apply. Otherwise
+apply the patch and then use "git commit --author ..."
+
+Regardless:
+
+== Nontrivial changes ==
+Nontrivial patches should always go through Bugzilla for peer review, so
+you should have a bug number. The commit should be of the form:
+
+Bug XXXXXX: Single line summary here
+
+ * dbus/filename.c: Why I changed this.
+ * dbus/otherfile.c: Why I changed this.
+
+== Trivial changes ==
+
+Just use a single line summary, like:
+
+Fix typo in NEWS
+
= Making a release =
DBus-Glib now uses an even-stable odd-development release numbering