Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100755 105 lines (72 sloc) 4.109 kb
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
1 JSHint, A Static Code Analysis Tool for JavaScript
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
2 ==================================================
3
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
4 JSHint is a community-driven tool to detect errors and potential problems in
5 JavaScript code and to enforce your team's coding conventions.
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
6
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
7 **IMPORTANT**:
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
8
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
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.
521230d Anton Kovalyov Updated README to reflect the latest edition release
valueof authored
15
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
16 Reporting a bug
17 ---------------
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
18
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
19 To report a bug simply create a [new GitHub Issue](https://github.com/jshint/jshint/issues/new) and
20 describe your problem or suggestion. We welcome all kind of feedback regarding JSHint including but
21 not limited to:
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
22
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
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
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
26
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
27 Please, before reporting a bug look around to see if there are any open or closed tickets that
28 cover your issue. And remember the wisdom: pull request > bug report > tweet.
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
29
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
30 Submitting patches
31 ------------------
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
32
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
33 The best way to make sure your issue is addressed is to submit a patch. GitHub provides a very
34 nice interface--pull requests--for that but we accept patches through all mediums: email, issue
35 comment, tweet with a link to a snippet, etc.
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
36
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
37 Before submitting a patch make sure that you comply to our style. We don't have specific style
38 guide so just look around the code you are changing.
4c4671b Anton Kovalyov Changed README to describe the philosophy of JSHint
valueof authored
39
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
40 Also, make sure that you write tests for new features and make sure that all tests pass before
41 submitting a patch. Patches that break the build will be rejected.
a0bbd0b Rob Friesel add JSC usage to the README
founddrama authored
42
73f5bab Anton Kovalyov Added information about feature freeze in JSHint.
valueof authored
43 **FEATURE FREEZE**: Please note that we currently have a feature freeze on new environments and
44 styling options. The only patches we accept at this time are for bug fixes.
45
506e46b Anton Kovalyov Added first tests for JSHint (you will need node-jasmine to run them)
valueof authored
46 Tests
47 -----
48
49 To run tests you will need to install [node.js](http://nodejs.org/) and
2f53fdd Anton Kovalyov Removed Jasmine tests, test runner and mention in the README
valueof authored
50 expresso. You can install the latter with npm:
506e46b Anton Kovalyov Added first tests for JSHint (you will need node-jasmine to run them)
valueof authored
51
2f53fdd Anton Kovalyov Removed Jasmine tests, test runner and mention in the README
valueof authored
52 npm install expresso
521230d Anton Kovalyov Updated README to reflect the latest edition release
valueof authored
53
c278892 Wolfgang Kluge Structure test files
WolfgangKluge authored
54 After that, running the unit tests is as easy as:
506e46b Anton Kovalyov Added first tests for JSHint (you will need node-jasmine to run them)
valueof authored
55
c278892 Wolfgang Kluge Structure test files
WolfgangKluge authored
56 expresso tests/unit/*.js
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
57
8fead2b Anton Kovalyov Added Attribution section
valueof authored
58 Attribution
59 -----------
60
5b5470a Anton Kovalyov Josh and Wolfgang are now core contributors, congrats
valueof authored
61 Core Team members:
8fead2b Anton Kovalyov Added Attribution section
valueof authored
62
5b5470a Anton Kovalyov Josh and Wolfgang are now core contributors, congrats
valueof authored
63 * [Anton Kovalyov](http://anton.kovalyov.net/) ([@valueof](http://twitter.com/valueof))
e54492a Anton Kovalyov Added links for Wolfgang Kluge
valueof authored
64 * [Wolfgang Kluge](http://klugesoftware.de/) ([blog](http://gehirnwindung.de/))
5b5470a Anton Kovalyov Josh and Wolfgang are now core contributors, congrats
valueof authored
65 * [Josh Perez](http://www.goatslacker.com/) ([@goatslacker](http://twitter.com/goatslacker))
66
67 Maintainer: Anton Kovalyov
8fead2b Anton Kovalyov Added Attribution section
valueof authored
68
a83874a Amir E. Aharoni Add the license to README
amire80 authored
69 License
70 -------
71
72 JSHint is licensed under the same slightly modified MIT license that JSLint is.
73 It stops evil-doers everywhere.
74
75 JSHint is a derivative work of JSLint:
76
77 Copyright (c) 2002 Douglas Crockford (www.JSLint.com)
78
79 Permission is hereby granted, free of charge, to any person obtaining
80 a copy of this software and associated documentation files (the "Software"),
81 to deal in the Software without restriction, including without limitation
82 the rights to use, copy, modify, merge, publish, distribute, sublicense,
83 and/or sell copies of the Software, and to permit persons to whom
84 the Software is furnished to do so, subject to the following conditions:
85
86 The above copyright notice and this permission notice shall be included
87 in all copies or substantial portions of the Software.
88
89 The Software shall be used for Good, not Evil.
90
91 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
92 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
93 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
94 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
95 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
96 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
97 DEALINGS IN THE SOFTWARE.
98
99 JSHint was forked from the 2010-12-16 edition of JSLint.
100
92ee83c Anton Kovalyov New README with information for contributors
valueof authored
101 Thank you!
102 ----------
103
a9dd583 Kyle Robinson Young Typo fix
shama authored
104 We really appreciate all kind of feedback and contributions. Thanks for using and supporting JSHint!
Something went wrong with that request. Please try again.