Skip to content

Commit fa2d6ff

Browse files
Macrozbbatsov
authored andcommitted
Describe common development setup for contributors
1 parent 48b9d73 commit fa2d6ff

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,19 @@ clojure-mode (version 2.1.1)
3434
* [Squash related commits together][5].
3535
* Open a [pull request][4] that relates to *only* one subject with a clear title
3636
and description in grammatically correct, complete sentences.
37-
* When applicable, attach ERT unit tests.
37+
* When applicable, attach ERT unit tests. See below for instructions on running the tests.
38+
39+
## Development setup
40+
41+
1. Fork and clone the repository
42+
1. Install [Cask][7] as per the instructions there.
43+
1. With Cask in your path run `cask install` in the repository folder.
44+
1. Run tests with `make test`.
3845

3946
[1]: https://github.com/clojure-emacs/clojure-mode/issues
4047
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
4148
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
4249
[4]: https://help.github.com/articles/using-pull-requests
4350
[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
4451
[6]: https://github.com/clojure-emacs/clojure-mode/blob/master/CHANGELOG.md
52+
[7]: https://github.com/cask/cask

0 commit comments

Comments
 (0)