From b7a5a6785f94663098202f08d5d3defb3d43ba82 Mon Sep 17 00:00:00 2001 From: Hannu Hartikainen Date: Wed, 31 Oct 2018 09:36:45 +0200 Subject: [PATCH] Correct testing instructions for contributors --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88fd2906..e52b0c54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,21 @@ -How to contribute +# How to contribute Contributions are welcome. Please file bug reports and feature requests to https://github.com/metosin/reitit/issues. +## Environment setup + +1. Clone this git repository +2. For CLJS support, install NPM dependencies: `npm install`. + ## Making changes * Fork the repository on Github * Create a topic branch from where you want to base your work (usually the master branch) * Check the formatting rules from existing code (no trailing whitepace, mostly default indentation) * Ensure any new code is well-tested, and if possible, any issue fixed is covered by one or more new tests -* Verify that all tests pass using ```lein test``` +* Verify that all tests pass using `./scripts/test.sh clj` and `./scripts/test.sh cljs`. * Push your code to your fork of the repository * Make a Pull Request