Correct testing instructions for contributors

This commit is contained in:
Hannu Hartikainen 2018-10-31 09:36:45 +02:00 committed by GitHub
parent 2d045511bb
commit b7a5a6785f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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