]> code.delx.au - gnu-emacs-elpa/commitdiff
Add a CONTRIBUTING.md file
authorNoam Postavsky <npostavs@users.sourceforge.net>
Wed, 18 Mar 2015 19:59:28 +0000 (15:59 -0400)
committerNoam Postavsky <npostavs@users.sourceforge.net>
Wed, 18 Mar 2015 19:59:28 +0000 (15:59 -0400)
Collect some conventions about contributing to Yasnippet (which have
been scattered amongst various issues/pull request) into a single file.

* CONTRIBUTING.md: New File.

CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..83310bc
--- /dev/null
@@ -0,0 +1,27 @@
+# Submitting Bug Reports\r
+\r
+Please read [Important note regarding bug reporting][bugnote].\r
+\r
+# Contributing to Yasnippet\r
+\r
+## Copyright Assignment\r
+\r
+Yasnippet is part of GNU ELPA, so it falls under the same copyright\r
+assignment policy as the rest of Emacs (see "Copyright Assignment" in\r
+https://www.gnu.org/software/emacs/CONTRIBUTE). A copyright assignment\r
+for Emacs also covers Yasnippet.\r
+\r
+## Commit message format\r
+\r
+The commit message format roughly follows Emacs conventions, although\r
+there is no separate Changelog file.\r
+\r
+    The commit message's first sentence should be capitalized, no period\r
+\r
+    It may be followed by a paragraph with a longer explanation. The\r
+    changelog style entry goes at the end of the message.\r
+\r
+    * foo.el (a-function): Terse summary of per-function changes.\r
+\r
+\r
+[bugnote]: https://github.com/capitaomorte/yasnippet#important-note-regarding-bug-reporting\r