[diffoscope] 01/02: README.rst: Merge in content from CONTRIBUTING.

[Chris Lamb]

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

lamby pushed a commit to branch master
in repository diffoscope.

commit bcd117ce143a03c9b65b6419820038795a388673
Author: Chris Lamb <lamby at debian.org>
Date:   Sat Feb 4 19:23:56 2017 +1300

    README.rst: Merge in content from CONTRIBUTING.
    
    Signed-off-by: Chris Lamb <lamby at debian.org>
---
 CONTRIBUTING | 61 --------------------------------------------------
 README.rst   | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+), 61 deletions(-)

diff --git a/CONTRIBUTING b/CONTRIBUTING
deleted file mode 100644
index 1f93a6a..0000000
--- a/CONTRIBUTING
+++ /dev/null
@@ -1,61 +0,0 @@
-=== 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 'diffoscope' package.  You can do this over e-mail, simply
-write an email to link:mailto:submit at bugs.debian.org with 'Source: diffoscope'
-as the very first line; there are link:https://www.debian.org/Bugs/Reporting[
-more detailed instructions available] about reporting a bug in the Debian bug
-tracker.
-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/[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
-----
-
-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
-
-When uploading diffoscope to the Debian archive, please take extra care to
-make sure the uploaded source package is correct, that is it includes the
-files tests/data/test(1|2).(a|o) which in some cases are removed by dpkg-dev
-when building the package. See https://bugs.debian.org/834315 for an example
-ftbfs bug caused by this and see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=735377#44
-and followups to learn how this happened and how to prevent it.
-
-Please also release a signed tarball:
-
-----
-  $ VERSION=FIXME
-  $ git archive --format=tar --prefix=diffoscope-${VERSION}/ ${VERSION} | bzip2 -9 > diffoscope-${VERSION}.tar.bz2
-  $ gpg --detach-sig --armor --output=diffoscope-${VERSION}.tar.bz2.asc < diffoscope-${VERSION}.tar.bz2
-  $ scp diffoscope-${VERSION}* alioth.debian.org:/home/groups/reproducible/htdocs/releases/diffoscope
-----
-
-After uploading, please also update the version on PyPI using::
-
-   $ python3 setup.py sdist upload --sign
-
-Once the tracker.debian.org entry appears, consider tweeting the release on
-#reproducible-builds with:
-
-  %twitter diffoscope $VERSION has been released. Check out the changelog here: $URL
-
-
-// vim: set filetype=asciidoc:
diff --git a/README.rst b/README.rst
index dd3c795..e7c95da 100644
--- a/README.rst
+++ b/README.rst
@@ -51,6 +51,78 @@ get a list of them, please run::
 
     $ bin/diffoscope --list-tools
 
+Contributing
+------------
+
+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 ``diffoscope`` package. You can do this over e-mail, simply write an email
+as follows:
+
+::
+
+    To: submit at bugs.debian.org
+    Subject: <subject>
+
+    Source: diffoscope
+    Version: <version>
+    Severity: <grave|serious|important|normal|minor|wishlist>
+
+
+There are `more detailed instructions available
+<https://www.debian.org/Bugs/Reporting>`__ more detailed instructions
+available] about reporting a bug in the Debian bug tracker.
+
+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 also submit patches to the Debian bug tracke. Start by cloning the `Git
+repository <https://anonscm.debian.org/git/reproducible/diffoscope.git/>`__,
+make your changes and commit them as you normally would. You can then use
+Git's ``format-patch`` command to save your changes as a series of patches that
+can be attached to the report you submit. For example:
+
+::
+
+    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
+
+The ``format-patch`` command will create a series of ``.patch`` files in your
+checkout. Attach these files to your submission in your e-mail client or
+reportbug.
+
+Uploading the package
+----------------------
+
+When uploading diffoscope to the Debian archive, please take extra care to make
+sure the uploaded source package is correct, that is it includes the files
+tests/data/test(1|2).(a|o) which in some cases are removed by dpkg-dev when
+building the package. See `#834315 <https://bugs.debian.org/834315>`__ for an example
+FTBFS bug caused by this. (See `#735377
+<https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=735377#44>`__ and followups
+to learn how this happened and how to prevent it)
+
+Please also release a signed tarball::
+
+    $ VERSION=FIXME
+    $ git archive --format=tar --prefix=diffoscope-${VERSION}/ ${VERSION} | bzip2 -9 > diffoscope-${VERSION}.tar.bz2
+    $ gpg --detach-sig --armor --output=diffoscope-${VERSION}.tar.bz2.asc < diffoscope-${VERSION}.tar.bz2
+    $ scp diffoscope-${VERSION}* alioth.debian.org:/home/groups/reproducible/htdocs/releases/diffoscope
+
+After uploading, please also update the version on PyPI using::
+
+   $ python3 setup.py sdist upload --sign
+
+Once the tracker.debian.org entry appears, consider tweeting the release on
+``#reproducible-builds`` with::
+
+  %twitter diffoscope $VERSION has been released. Check out the changelog here: $URL
+
+
 Contributors
 ------------
 
@@ -71,6 +143,7 @@ Join the users and developers mailing-list:
 
 diffoscope website is at <https://diffoscope.org/>
 
+
 License
 -------
 

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