ld/yasnippet
1
0
Fork 0
mirror of https://github.com/joaotavora/yasnippet.git synced 2025-10-13 05:03:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md information

Browse Source 
* 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.
This commit is contained in:
Noam Postavsky 2017-04-22 23:59:01 -04:00
parent 1436d211d2
commit 2a3a0cd2b1
2 changed files with 40 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -1,4 +1,8 @@
# Submitting Bug Reports
# Submitting Bug Reports or Patches
As a GNU ELPA package, bugs or patches may be submitted to the main
Emacs bug list, bug-gnu-emacs@gnu.org. Alternatively, you may use the
[Github issue tracker][issues].
Please read [Important note regarding bug reporting][bugnote].
@ -13,17 +17,21 @@ 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 format roughly follows Emacs conventions. There is
no separate Changelog file.
The commit message's first sentence should be capitalized, no period
Capitalize the first sentence, no period at the end
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.
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
(the `* foo.el ...` part) is fine.
(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

4
README.mdown
View File

@ -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,
bug-gnu-emacs@gnu.org, and put "yasnippet" somewhere in the subject.
Alternatively, you may use the [Github issue tracker][issues].
## Important note regarding bug reporting