]> code.delx.au - gnu-emacs-elpa/commitdiff
doc: be even clearer about snippet contribution policy
authorJoão Távora <joaotavora@gmail.com>
Wed, 18 Jul 2012 01:56:08 +0000 (02:56 +0100)
committerJoão Távora <joaotavora@gmail.com>
Wed, 18 Jul 2012 01:56:08 +0000 (02:56 +0100)
README.mdown

index bd76bbabcab0cd196c1e367e2ff1ea116a76ecaf..0cf7e71dc54ccb8a5b847afdbd3337c9c3d96c98 100644 (file)
@@ -66,12 +66,28 @@ To use yasnippet as a non-global minor mode, replace `(yas/global-mode 1)` with
               '(lambda ()
                  (yas/minor-mode)))
 
-# Contributing snippets
+# (NOT) Contributing snippets
+
+Please **do not** open pull requests or ask me to add snippets to
+yasnippet.
+
+The bundled collection under `/snippets` is considered frozen: **I
+will not add more snippets to it**.
+
+You can point `yas/snippet-dirs` to good snippet collections out
+there. If you have created snippets for a mode, or multiple modes,
+consider creating a repository to host them, then tell users that it
+should be added like this to `yas/snippet-dirs`:
+
+    (setq yas/snippet-dirs
+          '("~/.emacs.d/snippets"            ;; personal snippets
+            "/path/to/some/collection/"      ;; just some foo-mode snippets
+            "/path/to/some/othercollection/" ;; some more foo-mode and a complete baz-mode
+            "/path/to/yasnippet/snippets"    ;; the default collection
+            ))
+
+    (yas/global-mode 1) ;; or M-x yas/reload-all if you've started yasnippet already.
 
-Please **do not** ask me to add snippets to the default collection under
-`/snippets`. This is considered frozen and by customizing
-`yas/snippet-dirs` you can point yasnippet to good snippet collections
-out there.
 
 There is a tool `extras/textmate-import.rb` than can import many
 actual Textmate snippets and there are