[Git][reproducible-builds/diffoscope][master] 3 commits: Tidy the CONTRIBUTING.md file a little.

[Chris Lamb]

Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
7b3a34f6 by Chris Lamb at 2020-07-23T15:54:48+01:00
Tidy the CONTRIBUTING.md file a little.

- - - - -
42afe44d by Chris Lamb at 2020-07-23T15:55:52+01:00
CONTRIBUTING.md: Add reminder to regenerate debian/tests/control.

- - - - -
64378888 by Chris Lamb at 2020-07-23T15:58:43+01:00
CONTRIBUTING.md: Update and expand the release process documentation.

- - - - -


1 changed file:

- CONTRIBUTING.md


Changes:

=====================================
CONTRIBUTING.md
=====================================
@@ -18,6 +18,17 @@ about *Merge Requests*.
 You can also submit bugs about Debian specific issues to the Debian bug
 tracker.
 
+## Testing
+
+diffoscope's test suite relies on [pytest](https://docs.pytest.org/);
+to run all tests use `pytest[-3]`, appending `-n 4` or similar to enable
+running tests concurrently. For faster interactive development here's
+an example of how to run a (much) smaller subset of tests:
+
+    $ pytest -v --exitfirst -k lib tests/comparators/test_elf.pyc [-pdb]
+
+More options are available at `[pytest -h]`.
+
 ## Git setup
 
 diffoscope's codebase adheres to the output
@@ -29,16 +40,6 @@ As an optional step, you can ignore these commits using:
 
     $ git config blame.ignoreRevsFile .git-blame-ignore-revs
 
-## Testing
-
-diffoscope's test suite relies on [pytest](https://docs.pytest.org/);
-to run all tests use `pytest[-3]`, appending `-n 4` or similar to enable
-running tests concurrently. For faster interactive development here's
-an example of how to run a (much) smaller subset of tests:
-
-    $ pytest -v --exitfirst -k lib tests/comparators/test_elf.pyc [-pdb]
-
-More options are available at `[pytest -h]`.
 
 ## Add a comparator
 
@@ -47,17 +48,25 @@ the project! Each file type is handled by a comparator, and writing a
 new one is usually very easy. Here are the steps to add a new
 comparator:
 
--   Add the new comparator in `diffoscope/comparators/` (have a look at
-    the other comparators in the same directory to have an idea of what
-    to do)
--   Declare the comparator File class in `ComparatorManager` in
-    `diffoscope/comparators/__init__.py`
--   Add a test in `tests/comparators/`
--   If required, update the `Build-Depends` list in `debian/control`
--   If required, update the `EXTERNAL_TOOLS` list in
-    `diffoscope/external_tools.py`
+* Add the new comparator in `diffoscope/comparators`.
+
+* Declare the comparator File class in `ComparatorManager` in
+  `diffoscope/comparators/__init__.py`
+
+* Add a test under `tests/comparators/`
+
+* If required:
+
+  - Update the `Build-Depends` list in `debian/control` and regenerate
+    `debian/tests/control` by following the instructions in that file.
+
+  - Update the `EXTERNAL_TOOLS` list in
+   `diffoscope/external_tools.py`
 
-## Uploading the package
+
+## Release process
+
+### Uploading to Debian
 
 When uploading diffoscope to the Debian archive, please take extra care
 to make sure the uploaded source package is correct, that is it includes
@@ -68,6 +77,8 @@ See [#834315](https://bugs.debian.org/834315) for an example FTBFS bug
 caused by this. (See [#735377](https://bugs.debian.org/735377#44)
 and followups to learn how this happened and how to prevent it)
 
+### Signed tarballs
+
 Please also release a signed tarball:
 
     $ VERSION=FIXME
@@ -78,16 +89,23 @@ And commit them to our LFS repository at:
 
     https://salsa.debian.org/reproducible-builds/reproducible-lfs
 
-After uploading, please also update the version on PyPI using:
+### PyPI
 
-    $ python3 setup.py sdist upload --sign
+You can update the version on PyPI using:
 
-Once the tracker.debian.org entry appears, consider tweeting the release
-on `#reproducible-builds` with:
+    $ python3 setup.py sdist upload --sign
 
-    %twitter diffoscope $VERSION has been released. Check out the changelog here: $URL
+### Docker image
 
-Finally, update the Docker image using:
+Update the Docker image using:
 
     $ docker build --force-rm --no-cache --pull -t registry.salsa.debian.org/reproducible-builds/diffoscope .
     $ docker push registry.salsa.debian.org/reproducible-builds/diffoscope
+
+### Publicity
+
+To announce the package on the `diffoscope.org` homepage, use the `update`
+script in that repository.
+
+Once live entry appears, consider tweeting the release using the release from
+the `@reprobuilds` Twitter account.



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/compare/4d89836cb983845b626c83ff6588ea4bc025c8d8...64378888fc466ebce51017d98fad8ece756ba5df

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/compare/4d89836cb983845b626c83ff6588ea4bc025c8d8...64378888fc466ebce51017d98fad8ece756ba5df
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20200723/de55cdb5/attachment.htm>