re-frame/CONTRIBUTING.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

2015-07-27 07:28:52 +00:00
# Contributing to re-frame
Thank you for taking the time to contribute!
2015-07-27 07:28:52 +00:00
## Support questions
The Github issues are for bug reports and feature requests only. Support requests and usage
questions should go to the re-frame [Clojure Slack channel](http://clojurians.net) or
the [ClojureScript mailing list](https://groups.google.com/forum/#!forum/clojurescript).
2015-07-27 07:28:52 +00:00
## Pull requests
2015-07-27 07:28:52 +00:00
**Create pull requests to the develop branch**, work will be merged onto master when it is ready to be released.
2015-07-27 07:28:52 +00:00
## Running tests
2015-07-27 07:28:52 +00:00
#### Via Browser/HTML
2015-07-27 07:28:52 +00:00
To build the tests and run them in one step, just:
```sh
lein test-once # compiles & then opens test.html in the browser
```
You can also get auto compiles via:
```sh
lein test-auto
```
but you'll need to manually open `test/test.html` in a browser. And you'll also need to
manually reload this page after each auto compile.
#### Via Karma
To run the tests, you must have recent versions of node, npm, Leiningen, and a C++ compiler
toolchain installed. If you're on Linux or Mac OS X then you will be fine,
if you're on Windows then you need to install Visual Studio Community Edition,
and the C++ compiler dependencies.
```sh
lein deps # runs lein-npm, installs Karma & other node dependencies. Only needed the first time.
lein karma-once # to build re-frame tests
karma start # to run the tests with an auto watcher
```
2015-07-27 07:28:52 +00:00
## Pull requests for bugs
If possible provide:
* Code that fixes the bug
* Failing tests which pass with the new changes
* Improvements to documentation to make it less likely that others will run into issues (if relevant).
* Add the change to the Unreleased section of [CHANGES.md](CHANGES.md)
## Pull requests for features
If possible provide:
* Code that implements the new feature
* Tests to cover the new feature including all of the code paths
* Docstrings for functions
* Documentation examples
* Add the change to the Unreleased section of [CHANGES.md](CHANGES.md)