From ec0a0fa88f3f6336ca8ddc51ed56567d810b6257 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Wed, 18 Jul 2012 02:56:08 +0100 Subject: [PATCH] doc: be even clearer about snippet contribution policy --- README.mdown | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.mdown b/README.mdown index bd76bba..0cf7e71 100644 --- a/README.mdown +++ b/README.mdown @@ -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