knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README][s]: add instructions for contributors.

Browse Source
This commit is contained in:
Rufus Pollock 2012-09-09 11:14:12 +01:00
parent 5542e2e23b
commit f823459561
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -17,6 +17,22 @@ A simple but powerful library for building data applications in pure Javascript
Running the tests by opening `test/index.html` in your browser.
### Contributing
We welcome patches and pull requests and have a few guidelines.
For small bugfixes or enhancements:
* Please run the tests
For larger changes:
* Cleanup your code and affected code parts
* Run the tests from test/index.html in different browsers (at least Chrome and FF)
* Update the documentation and tutorials where necessary
* Update _layouts/recline-deps.html if you change required files (e.g. leaflet libraries)
* Try to build the demos in /demos with jekyll and then check out the demos/multiview/ which utilizes most aspects of Recline
## Changelog