Merge pull request #1 from kberg/add-per-series-to-tests
[dygraphs.git] / jshint / README.markdown
CommitLineData
758a629f
DV
1JSHint, A Static Code Analysis Tool for JavaScript
2==================================================
3
4JSHint is a community-driven tool to detect errors and potential problems in
5JavaScript code and to enforce your team's coding conventions.
6
7**IMPORTANT**:
8
9 * This README is for people who are thinking about contributing to JSHint. For general usage
10 please refer to [our website](http://jshint.com/).
11 * If you want to report a bug about the website, please go to the
12 [jshint/site](https://github.com/jshint/site/) repository.
13 * If you want to report a bug or contribute to our NPM package, please go to the
14 [jshint/node-jshint](https://github.com/jshint/node-jshint/) repository.
15
16Reporting a bug
17---------------
18
19To report a bug simply create a [new GitHub Issue](https://github.com/jshint/jshint/issues/new) and
20describe your problem or suggestion. We welcome all kind of feedback regarding JSHint including but
21not limited to:
22
23 * When JSHint doesn't work as expected
24 * When JSHint complains about valid JavaScript code that works in all browsers
25 * When you simply want a new option or feature
26
27Please, before reporting a bug look around to see if there are any open or closed tickets that
28cover your issue. And remember the wisdom: pull request > bug report > tweet.
29
30Submitting patches
31------------------
32
33The best way to make sure your issue is addressed is to submit a patch. GitHub provides a very
34nice interface--pull requests--for that but we accept patches through all mediums: email, issue
35comment, tweet with a link to a snippet, etc.
36
37Before submitting a patch make sure that you comply to our style. We don't have specific style
38guide so just look around the code you are changing.
39
40Also, make sure that you write tests for new features and make sure that all tests pass before
41submitting a patch. Patches that break the build will be rejected.
42
43**FEATURE FREEZE**: Please note that we currently have a feature freeze on new environments and
44styling options. The only patches we accept at this time are for bug fixes.
45
46Tests
47-----
48
49To run tests you will need to install [node.js](http://nodejs.org/) and
50expresso. You can install the latter with npm:
51
52 npm install expresso
53
54After that, running tests is as easy as:
55
56 expresso tests/*.js
57
58Attribution
59-----------
60
61Maintainer: [Anton Kovalyov](http://anton.kovalyov.net/) ([@valueof](http://twitter.com/valueof))
62
63Distinguished Contributors:
64
65 * [Wolfgang Kluge](http://klugesoftware.de/) ([blog](http://gehirnwindung.de/))
66 * [Josh Perez](http://www.goatslacker.com/)
67
68Thank you!
69----------
70
71We really appreciate all kind of feedback and contributions. Thanks for using and supporing JSHint!