Added contributing section

[debbugs.git] / README

diff --git a/README b/README
index d2376edd1066d87df0a7b662479351b592d96bb9..c5a9a6596c99b9c41896e17c98d2ffabe8952dd1 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,11 @@ with assistance from nCipher Corporation Limited in 1997.  nCipher allowed
 Ian to redistribute modifications he made to the system while working as an
 employee of nCipher.
 
+Since then, it has been developed by the various administrators of
+bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
+Towns, and Colin Watson.  As in the case of Ian, nCipher allowed Colin to
+redistribute modifications he made while working as an employee of nCipher.
+
 =============================================================================
 SYSTEM REQUIREMENTS
 =============================================================================
@@ -65,6 +70,44 @@ this: "package       maintainer name <e-mail@address>".
 
 If you need a template, look in /usr/share/doc/debbugs/examples/ directory.
 
+=============================================================================
+CONTRIBUTING TO DEBBUGS
+=============================================================================
+
+Getting the Source Code
+
+Debbugs is managed in git. You can clone the repository into your local workspace as follows:
+
+git clone http://bugs-master.debian.org/debbugs-source/debbugs.git
+
+Additional branches are available from:
+
+ * http://git.donarmstrong.com/debbugs.git/ (Maintainer: Don Armstrong)
+
+Make a working branch for your code and check it out to start working:
+
+git checkout -b example-branch
+
+Stage and commit your changes using appropriate commit messages
+
+git add example-file
+
+git commit -m "Created an example file to demonstrate basic git commands."
+
+Submitting a Patch
+
+Submitting a patch can be done using git format-patch.
+
+For example 
+
+git format-patch origin/master
+
+Creates .patch files for all commits since the branch diverged from master.
+
+Debbugs bugs are tracked using debbugs (what else). Patches should therefore be attached to the bug report for the issue. This can be done by emailing xxxx@bugs.debian.org (where xxxx is the bug number) with the patches attached. That's a terrible way of saying it, Stoopid.
+ 
+Feature patches can also be emailed to the maintaining list at  debian-debbugs@lists.debian.org
+
 =============================================================================
 FURTHER INFORMATION
 =============================================================================