summaryrefslogtreecommitdiff
path: root/CONTRIBUTING
blob: fbe48bf150746171021ec3b00ad2abd52e2dd9ed (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
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.

Instead, either

- publish a branch somewhere (a GitHub fork is fine), and e-mail
  <spwhitton@spwhitton.name> asking me to merge your branch, possibly
  using git-request-pull(1)

- prepare patches with git-format-patch(1), and send them to
  <spwhitton@spwhitton.name>, probably using git-send-email(1)

You may find <https://git-send-email.io/> useful.

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

Please use the CPAN bug tracker:
<https://rt.cpan.org/Public/Dist/Display.html?Name=API-GitForge>

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 the
file ``COPYING``.  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>