[diffoscope] 03/04: CONTRIBUTING: Refresh instructions for contributing to diffoscope.

Mattia Rizzolo mattia at debian.org
Sat Jan 21 00:19:46 CET 2017


This is an automated email from the git hooks/post-receive script.

mattia pushed a commit to branch master
in repository diffoscope.

commit e7f77314b7e172b0a3d1d528922b49c4598c45fe
Author: Brett Smith <brettcsmith at brettcsmith.org>
Date:   Fri Jan 20 13:12:33 2017 -0500

    CONTRIBUTING: Refresh instructions for contributing to diffoscope.
    
    The previous instructions suggested multiple ways to contribute.  Personally
    I didn't feel sure which one was really right to use.  These encourage the
    reader to send everything to the BTS, based on the conversation at
    <http://meetbot.debian.net/reproducible-builds/2017/reproducible-builds.2017-01-03-18.00.log.html#l-38>.
    
    I also tried to make the instructions a little less Debian-specific by
    pointing people to the instructions for sending reports by e-mail, and then
    mentioning reportbug as a helper for people who have it.
    
    Signed-off-by: Mattia Rizzolo <mattia at debian.org>
---
 CONTRIBUTING | 36 +++++++++++++++++++-----------------
 1 file changed, 19 insertions(+), 17 deletions(-)

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 7dd9936..0efbfbf 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,30 +1,32 @@
-=== Contributing code to this project
-
-It's helpful to track fixes or new features via wishlist bugs against the
-'diffoscope' package, eg with the 'reportbug' tool ('devscripts' package).
-
-The code is available in the link:https://anonscm.debian.org/git/reproducible/diffoscope.git/tree/[diffoscope.git repository].
-
-Patches can be submitted as requests to pull from a publicly-visible
-git repository (this is the prefered way) communicated via IRC or mail,
-or completly via mail (using git format-patch, see below).
-If appropriate, please make a topic branch based on the 'master' branch.
-
-You can send patches or requests to the link:diffoscope at lists.reproducible-builds.org[development list],
-or to the tracking bug: <bugnumber>@bugs.debian.org.
+=== Contributing to this project
+
+The preferred way to report bugs about diffoscope, as well as suggest fixes
+and requests for improvements, is to submit reports to the Debian bug
+tracker for the 'src:diffoscope' package.  You can do this over e-mail;
+link:https://www.debian.org/Bugs/Reporting[the bug tracker has instructions
+for sending in your report.]  If you're on a Debian-based system, you can
+install and use the 'reportbug' package to help walk you through the
+process.
+
+You can submit patches to the Debian bug tracker too.  Start by cloning the
+link:https://anonscm.debian.org/git/reproducible/diffoscope.git/tree/[diffoscope
+Git repository].  Make your changes and commit them as you normally would.
+Then you can use Git's 'format-patch' command to save your changes as a
+series of patches that can be attached to the report you submit.
 
 One possible workflow:
 ----
   git clone git://anonscm.debian.org/reproducible/diffoscope.git
+  cd diffoscope
   git checkout origin/master -b <topicname>
   # <edits>
   git commit -a
   git format-patch -M origin/master
-
-  reportbug qa.debian.org
-  # <describe the issue, attach the patch>
 ----
 
+The 'format-patch' command will make a series of '.patch' files in your
+checkout.  Attach these files to your submission in your e-mail client or
+reportbug.
 
 === Uploading the package
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/diffoscope.git


More information about the diffoscope mailing list