yogsototh/leiningen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add section about tests in CONTRIBUTING.md

Browse source
This commit is contained in:
Jean Niklas L'orange 2013-03-17 02:31:19 +01:00
parent 43a9994171
commit 179d829357
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -37,10 +37,6 @@ See the
and `doc/PLUGINS.md` for more details on how Leiningen's codebase is
structured.
While there is a test suite, it's not terribly thorough, so don't put
too much trust in it. Patches which add test coverage for the
functionality they change are especially welcome.
## Bootstrapping
You don't need to "build" Leiningen per se, but when you're developing on a
@ -64,3 +60,15 @@ Using `bin/lein` alone from the master branch without a full checkout
is not supported. If you want to just grab a shell script to work
with, use the `stable` branch.
## Tests
Before you're asking for a pull request, we would be very happy if you ensure
that the changes you've done doesn't break any of the existing test cases. While
there is a test suite, it's not terribly thorough, so don't put too much trust
in it. Patches which add test coverage for the functionality they change are
especially welcome.
To run the test cases, run `bin/lein test` in the root directory: This will test
both `leiningen-core` and `leiningen` itself. Do not attempt to run the tests
with a stable version of Leiningen, as the namespaces conflict and you may end
up with errors during the test run.