[gnome-packagekit] Add a commits file taken from Nautilus, and autogenerate the ChangeLog



commit df084eebee93749d250d6b93b0164634676313f9
Author: Richard Hughes <richard hughsie com>
Date:   Fri Apr 17 21:49:15 2009 +0100

    Add a commits file taken from Nautilus, and autogenerate the ChangeLog
---
 ChangeLog      |    4 ---
 Makefile.am    |   20 ++++++++++++++++
 README.commits |   68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
deleted file mode 100644
index 97f6720..0000000
--- a/ChangeLog
+++ /dev/null
@@ -1,4 +0,0 @@
-2007-08-23  Richard Hughes  <richard hughsie com>
-
-	* Initial commit
-
diff --git a/Makefile.am b/Makefile.am
index 2b9ea3f..cd48e52 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -30,3 +30,23 @@ DISTCLEANFILES =					\
 
 DISTCHECK_CONFIGURE_FLAGS = --disable-schemas-install --disable-scrollkeeper
 
+distclean-local:
+	if test $(srdcir) = .; then :; else \
+		rm -f ChangeLog; \
+	fi
+
+ChangeLog:
+	@echo Creating $@
+	@if test -d "$(srcdir)/.git"; then \
+	  (GIT_DIR=$(top_srcdir)/.git ./missing --run git log 699c5554d899c5f3d38adb60bc825009ff9a63cd.. --stat -M -C --name-status  --date=short --no-color) | fmt --split-only > $  tmp \
+	  && mv -f $  tmp $@ \
+	  || ($(RM) $  tmp; \
+	      echo Failed to generate ChangeLog, your ChangeLog may be outdated >&2; \
+	      (test -f $@ || echo git-log is required to generate this file >> $@)); \
+	else \
+	  test -f $@ || \
+	  (echo A git checkout and git-log is required to generate ChangeLog >&2 && \
+	  echo A git checkout and git-log is required to generate this file >> $@); \
+	fi
+
+.PHONY: ChangeLog
diff --git a/README.commits b/README.commits
new file mode 100644
index 0000000..f2a0bfa
--- /dev/null
+++ b/README.commits
@@ -0,0 +1,68 @@
+gnome-packagekit is part of the GNOME git repository. At the current time, any
+person with write access to the GNOME repository, can make changes to
+gnome-packagekit. This is a good thing, in that it encourages many people to work
+on gnome-packagekit, and progress can be made quickly. However, we'd like to ask
+people committing to gnome-packagekit to follow a few rules:
+
+0) Ask first. If your changes are major, or could possibly break existing
+   code, you should always ask. If your change is minor and you've
+   been working on gnome-packagekit for a while it probably isn't necessary
+   to ask. But when in doubt, ask. Even if your change is correct,
+   somebody may know a better way to do things.
+
+   If you are making changes to gnome-packagekit, you should be subscribed
+   to packagekit lists freedesktop org 
+   http://lists.freedesktop.org/mailman/listinfo/packagekit
+   This is a good place to ask about intended changes.
+
+   #PackageKit on Freenode is also a good place to find PackageKit developers
+   to discuss changes with.
+
+1) Ask _first_.
+
+2) With git, we no longer maintain a ChangeLog file, but you are expected
+   to produce a meaningful commit message. Changes without a sufficient
+   commit message will be reverted. See below for the expected format
+   of commit messages.
+
+3) Try to separate each change into multiple small commits that are
+   independent ("micro commits" in git speak). This way its easier to
+   see what each change does, making it easier to review, to cherry pick
+   to other branches, to revert, and to bisect.
+
+Notes:
+
+* When developing larger features or complicated bug fixes, it is
+  advisable to work in a branch in your own cloned gnome-packagekit repository.
+  You may even consider making your repository publically available
+  so that others can easily test and review your changes.
+
+* The expected format for git commit messages is as follows:
+
+=== 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.
+
+
+Alexander Larsson
+17 Apr 2009



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]