[Git][reproducible-builds/diffoscope][master] CONTRIBUTING.md: Add a quick note about adding/suggesting new options. Can be expanded later.
Chris Lamb
gitlab at salsa.debian.org
Thu Jul 23 15:00:34 UTC 2020
Chris Lamb pushed to branch master at Reproducible Builds / diffoscope
Commits:
c66a7f65 by Chris Lamb at 2020-07-23T16:00:07+01:00
CONTRIBUTING.md: Add a quick note about adding/suggesting new options. Can be expanded later.
- - - - -
1 changed file:
- CONTRIBUTING.md
Changes:
=====================================
CONTRIBUTING.md
=====================================
@@ -40,8 +40,9 @@ As an optional step, you can ignore these commits using:
$ git config blame.ignoreRevsFile .git-blame-ignore-revs
+## Common development topics
-## Add a comparator
+### Adding a comparator
Diffoscope doesn't support a specific file type? Please contribute to
the project! Each file type is handled by a comparator, and writing a
@@ -63,6 +64,13 @@ comparator:
- Update the `EXTERNAL_TOOLS` list in
`diffoscope/external_tools.py`
+### Adding a new option
+
+Please try and refrain from adding new command-line options. A brief rationale
+may be found here:
+
+ https://salsa.debian.org/reproducible-builds/diffoscope/-/issues/18#note_183040
+
## Release process
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/c66a7f6569379a765abcd1d11ca26a940654b65b
--
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/commit/c66a7f6569379a765abcd1d11ca26a940654b65b
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/49c9caf1/attachment.htm>
More information about the rb-commits
mailing list