Skip to content

Commit 67dad35

Browse files
committed
contributions, stylistic conventions
1 parent 320e84c commit 67dad35

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,27 @@ Full list of snippets (it's ever growing):
5353
* `mapcar`
5454
* `mitlic` — MIT License header
5555

56-
Have fun!
56+
## Contributions
57+
58+
Yes, please contribute! There are some stylistic conventions:
59+
60+
1. Name files without any extensions;
61+
62+
2. Start every file with this preamble:
63+
64+
```
65+
# -*- mode: snippet -*-
66+
# contributor: your name
67+
# name: readable name of the snippet
68+
# key: what user needs to enter
69+
# --
70+
```
71+
72+
The first line is needed to activate mode for snippet editing in Emacs,
73+
Yasnippet ships with it.
74+
75+
3. Make sure your files don't have empty line at the end. This is important,
76+
because it will be inserted too, when your snippet is
77+
expanded. `snippet-mode` takes care of this, setting
78+
`require-finall-newline` to `nil`, just make sure I haven't put it there
79+
manually.

0 commit comments

Comments
 (0)