emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] master 2a3a0cd 61/63: Update CONTRIBUTING.md information


From: Noam Postavsky
Subject: [elpa] master 2a3a0cd 61/63: Update CONTRIBUTING.md information
Date: Mon, 17 Jul 2017 22:54:23 -0400 (EDT)

branch: master
commit 2a3a0cd2b18c21fc5f391273045f466c41da743c
Author: Noam Postavsky <address@hidden>
Commit: Noam Postavsky <address@hidden>

    Update CONTRIBUTING.md information
    
    * README.mdown: Note that bugs can be submitted to main Emacs list.
    * CONTRIBUTING.md: Fix double spacing, remove carriage returns.
    Tighten up commit message example.
---
 CONTRIBUTING.md | 66 ++++++++++++++++++++++++++++++++-------------------------
 README.mdown    |  4 +++-
 2 files changed, 40 insertions(+), 30 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 81c0a1f..bf3b2d3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,29 +1,37 @@
-# Submitting Bug Reports
-
-Please read [Important note regarding bug reporting][bugnote].
-
-# Contributing to Yasnippet
-
-## Copyright Assignment
-
-Yasnippet is part of GNU ELPA, so it falls under the same copyright
-assignment policy as the rest of Emacs (see "Copyright Assignment" in
-https://www.gnu.org/software/emacs/CONTRIBUTE). A copyright assignment
-for Emacs also covers Yasnippet.
-
-## Commit message format
-
-The commit message format roughly follows Emacs conventions, although
-there is no separate Changelog file.
-
-    The commit message's first sentence should be capitalized, no period
-
-    It may be followed by a paragraph with a longer explanation. The
-    changelog style entry goes at the end of the message.
-
-    * foo.el (a-function): Terse summary of per-function changes.
-
-For trivial changes, a message consisting of just the changelog entry
-(the `* foo.el ...` part) is fine.
-
-[bugnote]: 
https://github.com/joaotavora/yasnippet#important-note-regarding-bug-reporting
+# Submitting Bug Reports or Patches
+
+As a GNU ELPA package, bugs or patches may be submitted to the main
+Emacs bug list, address@hidden  Alternatively, you may use the
+[Github issue tracker][issues].
+
+Please read [Important note regarding bug reporting][bugnote].
+
+# Contributing to Yasnippet
+
+## Copyright Assignment
+
+Yasnippet is part of GNU ELPA, so it falls under the same copyright
+assignment policy as the rest of Emacs (see "Copyright Assignment" in
+https://www.gnu.org/software/emacs/CONTRIBUTE).  A copyright assignment
+for Emacs also covers Yasnippet.
+
+## Commit message format
+
+The commit message format roughly follows Emacs conventions.  There is
+no separate Changelog file.
+
+    Capitalize the first sentence, no period at the end
+
+    Please make sure the summary line can be understood without having
+    to lookup bug numbers.  It may be followed by a paragraph with a
+    longer explanation.  The changelog style entry goes at the end of
+    the message.
+    * foo.el (a-function): Terse summary of per-function changes.  Use
+    double spacing between sentences (set `sentence-end-double-space'
+    to t).
+
+For trivial changes, a message consisting of just the changelog entry
+(e.g., `* foo.el (a-function): Fix docstring typo.`) is fine.
+
+[bugnote]: 
https://github.com/joaotavora/yasnippet#important-note-regarding-bug-reporting
+[issues]: https://github.com/joaotavora/yasnippet/issues
diff --git a/README.mdown b/README.mdown
index f4e0594..e3d99f7 100644
--- a/README.mdown
+++ b/README.mdown
@@ -105,7 +105,9 @@ should be added like this to `yas-snippet-dirs`:
 
 Please refer to the comprehensive [documentation][docs] for full
 customisation and support.  If you find a bug in the code or in the
-documentation, please report it on [the GitHub issue tracker][issues].
+documentation, please report it to the main Emacs bug list,
address@hidden, and put "yasnippet" somewhere in the subject.
+Alternatively, you may use the [Github issue tracker][issues].
 
 ## Important note regarding bug reporting
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]