summaryrefslogtreecommitdiff
path: root/CONTRIBUTING
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2020-02-11 14:34:08 -0700
committerSean Whitton <spwhitton@spwhitton.name>2020-02-16 15:48:07 -0700
commit89b581c6fa663d8a9db728d98e7f56c83c991444 (patch)
tree1e4247118c26fb47e9353bc1344b65466d23969b /CONTRIBUTING
downloadp5-API-GitForge-89b581c6fa663d8a9db728d98e7f56c83c991444.tar.gz
rework script into API::GitForge generic interface
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING43
1 files changed, 43 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..fbe48bf
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,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>