luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-18 08:51:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Correct testing instructions for contributors

Browse source
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
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -1,16 +1,21 @@
How to contribute # How to contribute
Contributions are welcome. Contributions are welcome.
Please file bug reports and feature requests to https://github.com/metosin/reitit/issues. 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 ## Making changes
* Fork the repository on Github * Fork the repository on Github
* Create a topic branch from where you want to base your work (usually the master branch) * 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) * 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 * 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 * Push your code to your fork of the repository
* Make a Pull Request * Make a Pull Request