summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
blob: 7ef8682483b2cf81d42b9643aa7ecd1ed3016aca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Submitting patches
==================

Thank you for your interest in contributing to this project!

Please **do not** submit a pull request on GitHub.  The repository
there is an automated mirror, and I don't develop using GitHub's
platform.

Project mailing lists
=====================

There are two low-volume project mailing lists, shared with some other
small free software projects:

- sgo-software-announce --
  <https://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce>

  For release announcements.

- sgo-software-discuss --
  <https://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss>

  For bug reports, posting patches, user questions and discussion.

Please prepend ``[mailscripts]`` to the subject line of your e-mail,
and for patches, pass ``--subject-prefix="PATCH mailscripts"`` to
git-send-email(1).

Posting to sgo-software-discuss
-------------------------------

If you're not subscribed to the list, your posting will be held for
moderation; please be patient.

Whether or not you're subscribed, chiark.greenend.org.uk has
aggressive antispam.  If your messages aren't getting through, we can
easily add a bypass on chiark; please contact <spwhitton@spwhitton.name>.

If you don't want to deal with the mailing list and just want to send
patches, you should feel free to pass ``--to=spwhitton@spwhitton.name``
to git-send-email(1).

Alternatively, publish a git branch somewhere publically accessible (a
GitHub fork is fine) and write to me asking me to merge it.  I may
convert your branch back into patches when sending you feedback :)

IRC channel
===========

You can ask questions and discuss mailscripts in ``#notmuch`` on
server ``chat.freenode.net``.

Reporting bugs
==============

Please read "How to Report Bugs Effectively" to ensure your bug report
constitutes a useful contribution to the project:
<https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>

Signing off your commits
========================

Contributions are accepted upstream under the terms set out in
``debian/copyright`` and in the headers of individual source files.
Completely new scripts can use any DFSG-compatible license.  You must
certify the contents of the file ``DEVELOPER-CERTIFICATE`` for your
contribution.  To do this, append a ``Signed-off-by`` line to end of
your commit message.  An easy way to add this line is to pass the
``-s`` option to git-commit(1).  Here is an example of a
``Signed-off-by`` line:

::

    Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>