summaryrefslogtreecommitdiff
path: root/README.commits
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2009-04-17 10:24:37 +0200
committerAlexander Larsson <alexl@redhat.com>2009-04-17 10:24:37 +0200
commit6fa515051dc7f082896151545a41a29853f4a3bc (patch)
tree4e6047fb784049cdfe9228399435a3a100a51706 /README.commits
parent8cd532cf7715a4791d8156a711ecb7344b27cb46 (diff)
downloadgvfs-6fa515051dc7f082896151545a41a29853f4a3bc.tar.gz
Add README.commits and dist it
Add file explaining how we want commits to look. Also dist gvfs.doap and the ChangeLog.pre-1-2
Diffstat (limited to 'README.commits')
-rw-r--r--README.commits63
1 files changed, 63 insertions, 0 deletions
diff --git a/README.commits b/README.commits
new file mode 100644
index 00000000..d57e84c2
--- /dev/null
+++ b/README.commits
@@ -0,0 +1,63 @@
+GVfs is part of the GNOME git repository. At the current time, any
+person with write access to the GNOME repository, can make changes to
+GVfs. This is a good thing, in that it encourages many people to work
+on GVfs, and progress can be made quickly. However, we'd like to ask
+people committing to GVfs 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 GVfs 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 GVfs, you should be subscribed
+ to gvfs-list@gnome.org. (Subscription address:
+ gvfs-list-request@gnome.org.) This is a good place to ask
+ about intended changes.
+
+ #nautilus on GIMPNet (irc.gimp.org, irc.us.gimp.org, irc.eu.gimp.org, ...)
+ is also a good place to find GVfs 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.
+
+Notes:
+
+* When developing larger features or complicated bug fixes, it is
+ advisable to work in a branch in your own cloned GVfs 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