From 34e119266ff59d98cd75bc04430c6db7ca26dbe2 Mon Sep 17 00:00:00 2001 From: Phil Hagelberg Date: Thu, 12 Jan 2012 23:39:38 -0800 Subject: [PATCH] Update hacking guide. --- doc/HACKING.md | 43 ++++++------------------------------------- 1 file changed, 6 insertions(+), 37 deletions(-) diff --git a/doc/HACKING.md b/doc/HACKING.md index 262abfd3..0df6570a 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -23,9 +23,10 @@ specially-named namespaces: (pp/pprint project)) ``` -The docstring for the task will be used by `lein help`. In particular, -the first line will be used as a summary, so it needs to stand on its -own if you are going to have a longer multi-line explanation. +Task creation is documented in the +[plugins guide](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md). +The tasks that come with Leiningen are not plugins, but writing them +follows the exact same rules. ## Task Execution @@ -37,40 +38,8 @@ this as a subprocess using `leiningen.core.eval/eval-in-project`. Any code that must execute within the context of the project (AOT compilation, test runs) needs to go through this function. -The exception to this rule is when :eval-in-leiningen in -project.clj is true, as is commonly used for Leiningen plugins. - -Leiningen is extensible; you can define new tasks in plugins. Add your -plugin as a dev-dependency of your project, and you'll be able to call -lein $YOUR_COMMAND. - -See the -[plugins guide](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md) -for details. - -## Contributing - -The [mailing list](http://groups.google.com/group/leiningen) and the -leiningen or clojure channels on Freenode are the best places to -bring up questions or suggestions. If you're planning on adding a -feature or fixing a nontrivial bug, please discuss it first to avoid -duplicating effort. If you haven't discussed it on the mailing list, -please include in your pull request details of what problem your patch -intends to solve as well as the approach you took. - -Contributions are preferred as either Github pull requests or using -"git format-patch" and the mailing list as is requested [for -contributing to Clojure itself](http://clojure.org/patches). Please -use standard indentation with no tabs, trailing whitespace, or lines -longer than 80 columns. See [this post on submitting good -patches](http://technomancy.us/135) for some tips. If you've got some -time on your hands, reading this [style -guide](http://mumble.net/~campbell/scheme/style.txt) wouldn't hurt -either. - -See the [complete list of known issues](https://github.com/technomancy/leiningen/issues). - -TODO: integrate with plugin guide +The exception to this rule is when `:eval-in-leiningen` in +`project.clj` is true, as is commonly used for Leiningen plugins. # Release Checklist