From 45b7327d6384cfab9d9c7d2b660e46e206c916a6 Mon Sep 17 00:00:00 2001 From: Soonho Kong Date: Thu, 11 Sep 2014 12:29:00 -0700 Subject: [PATCH] doc(emacs/README.md): add contribution section --- src/emacs/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/emacs/README.md b/src/emacs/README.md index 76a51d794..7808b73f8 100644 --- a/src/emacs/README.md +++ b/src/emacs/README.md @@ -93,3 +93,23 @@ Key Bindings |TAB | lean-tab-indent-or-complete | |C-c C-o | lean-set-option | |C-c C-e | lean-eval-cmd | + +Contribution +------------ + +Contribution is welcome! + +If your contribution is a bug fix, create your topic branch from +`master`. If it is a new feature, check if there exists a +WIP(work-in-progress) branch (`vMAJOR.MINOR-wip`). If it does, use +that branch, otherwise use `master`. + +Install [Cask](https://github.com/cask/cask) if you haven't already, +then: + + $ cd /path/to/lean/src/emacs + $ cask + +Run all tests with: + + $ make