-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathcontributing.html
More file actions
223 lines (220 loc) · 11.5 KB
/
Copy pathcontributing.html
File metadata and controls
223 lines (220 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE html><!-- [if lt IE 7]>
<html lang="en" class="ie ie6"></html><![endif]-->
<!-- [if IE 7]>
<html lang="en" class="ie ie7"></html><![endif]-->
<!-- [if IE 8]>
<html lang="en" class="ie ie8"></html><![endif]-->
<!-- [if (gte IE 9)|!(IE)]>
<html lang="en"></html><![endif]-->
<head>
<!-- Basic Page Needs-->
<meta charset="utf-8">
<title>Karma - Contributing</title>
<!-- Mobile specific Metas-->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<meta name="description" content="">
<meta name="author" content="">
<!-- Le styles-->
<link href="/assets/css/app.css" rel="stylesheet">
<!-- HTML5 shim, for IE6-8 support of HTML5 elements--><!-- [if lt IE 9]>
<script src="/assets/js/html5.js"></script><![endif]-->
<!-- Fav and touch icons-->
<link rel="shortcut icon" href="/assets/img/favicon/favicon.ico">
<link rel="apple-touch-icon" href="/assets/img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="/assets/img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="/assets/img/apple-touch-icon-114x114.png">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/assets/img/apple-touch-icon-144x144.png">
<!-- canonical link for search engines-->
<link href="http://karma-runner.github.io/6.4/dev/contributing.html" rel="canonical">
</head>
<body>
<div class="deprecation-notice"><a href="https://github.com/karma-runner/karma?tab=readme-ov-file#karma-is-deprecated-and-is-not-accepting-new-features-or-general-bug-fixes">Karma is deprecated and is not accepting new features or general bug fixes</a></div>
<div id="wrap" class="boxed">
<header>
<div class="flash">
<b>Heads Up!</b> You're viewing the docs for <b>v0.10</b>, an old version of Karma.
<a href="/6.4/dev/contributing.html"><b>v6.4</b> is the newest</a>.
</div>
<div class="container clearfix">
<div class="six columns">
<div class="logo"><a href="/0.10/index.html"><img src="/assets/img/banner.png" alt="Karma - Spectacular Test Runner for JavaScript" title="Karma - Spectacular Test Runner for JavaScript"></a></div>
</div>
<div class="ten columns">
<nav id="menu" class="navigation">
<ul id="nav">
<li><a href="javascript:void">intro</a>
<ul>
<li><a href="/0.10/intro/installation.html">Installation</a></li>
<li><a href="/0.10/intro/configuration.html">Configuration</a></li>
<li><a href="/0.10/intro/how-it-works.html">How It Works</a></li>
<li><a href="/0.10/intro/faq.html">FAQ</a></li>
</ul>
</li>
<li><a href="javascript:void">config</a>
<ul>
<li><a href="/0.10/config/configuration-file.html">Configuration File</a></li>
<li><a href="/0.10/config/files.html">Files</a></li>
<li><a href="/0.10/config/browsers.html">Browsers</a></li>
<li><a href="/0.10/config/preprocessors.html">Preprocessors</a></li>
<li><a href="/0.10/config/plugins.html">Plugins</a></li>
</ul>
</li>
<li><a href="javascript:void">plus</a>
<ul>
<li><a href="/0.10/plus/requirejs.html">RequireJS</a></li>
<li><a href="/0.10/plus/travis.html">Travis CI</a></li>
<li><a href="/0.10/plus/jenkins.html">Jenkins CI</a></li>
<li><a href="/0.10/plus/semaphore.html">Semaphore CI</a></li>
<li><a href="/0.10/plus/cloud9.html">Cloud9</a></li>
<li><a href="/0.10/plus/angularjs.html">AngularJS</a></li>
<li><a href="/0.10/plus/yeoman.html">Yeoman</a></li>
<li><a href="/0.10/plus/emberjs.html">Ember.js</a></li>
</ul>
</li>
<li><a href="javascript:void" class="active">dev</a>
<ul>
<li><a href="/0.10/dev/public-api.html">Public Api</a></li>
<li><a href="/0.10/dev/plugins.html">Plugins</a></li>
<li><a href="/0.10/dev/contributing.html">Contributing</a></li>
</ul>
</li>
<li><a href="javascript:void">about</a>
<ul>
<li><a href="/0.10/about/versioning.html">Versioning</a></li>
<li><a href="/0.10/about/changelog.html">Changelog</a></li>
<li><a href="/0.10/about/migration.html">Migration</a></li>
</ul>
</li>
<li><a href="javascript:void">v0.10</a>
<ul>
<li><a href="/6.4/index.html">v6.4</a></li>
<li><a href="/6.3/index.html">v6.3</a></li>
<li><a href="/6.2/index.html">v6.2</a></li>
<li><a href="/6.1/index.html">v6.1</a></li>
<li><a href="/6.0/index.html">v6.0</a></li>
<li><a href="/5.2/index.html">v5.2</a></li>
<li><a href="/5.1/index.html">v5.1</a></li>
<li><a href="/5.0/index.html">v5.0</a></li>
<li><a href="/4.0/index.html">v4.0</a></li>
<li><a href="/3.0/index.html">v3.0</a></li>
<li><a href="/2.0/index.html">v2.0</a></li>
<li><a href="/1.0/index.html">v1.0</a></li>
<li><a href="/0.13/index.html">v0.13</a></li>
<li><a href="/0.12/index.html">v0.12</a></li>
<li><a href="/0.10/index.html">v0.10</a></li>
<li><a href="/0.8/index.html">v0.8</a></li>
<li><a href="/0.6/index.html">v0.6</a></li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="sixteen columns">
<hr>
</div>
</div>
</header>
<div class="container clearfix">
<div class="sixteen columns">
<h1 class="page-title">Contributing<span class="line"></span>
</h1>
</div>
<div class="page-columns">
<div id="markdown" class="sixteen columns bottom"><p>If you are thinking about making Karma better, or you just want to hack on it, that’s great!
Here are some tips to get you started.</p>
<h2 id="getting-started">Getting Started <a class="heading-anchor" href="#getting-started">#</a></h2>
<ul>
<li>Make sure you have a <a href="https://github.com/signup/free">GitHub account</a></li>
<li><a href="https://github.com/karma-runner/karma/issues/new">Submit</a> a ticket for your issue, assuming one does not
already exist.<ul>
<li>Clearly describe the issue including steps to reproduce when it is a bug.</li>
<li>Make sure you fill in the earliest version that you know has the issue.</li>
</ul>
</li>
<li>Fork the repository on GitHub</li>
</ul>
<h2 id="making-changes">Making Changes <a class="heading-anchor" href="#making-changes">#</a></h2>
<ul>
<li>Clone your fork<pre><code class="language-bash">$ git <span class="hljs-built_in">clone</span> git@github.com:<your-username>/karma.git
</code></pre>
</li>
<li>Init your workspace</li>
</ul>
<pre><code class="language-bash">$ ./scripts/init-dev-env.js
</code></pre>
<ul>
<li>Checkout a new branch (usually based on <code>master</code>) and name it accordingly to what
you intend to do<ul>
<li>Features get the prefix <code>feature-</code></li>
<li>Bug fixes get the prefix <code>fix-</code></li>
<li>Improvements to the documentation get the prefix <code>docs-</code></li>
</ul>
</li>
</ul>
<h2 id="testing-and-building">Testing and Building <a class="heading-anchor" href="#testing-and-building">#</a></h2>
<p>Run the tests via</p>
<pre><code class="language-bash"><span class="hljs-comment"># All tests</span>
$ grunt <span class="hljs-built_in">test</span>
$ grunt <span class="hljs-built_in">test</span>:unit
$ grunt <span class="hljs-built_in">test</span>:e2e
$ grunt <span class="hljs-built_in">test</span>:client
</code></pre>
<p>Lint the files via</p>
<pre><code class="language-bash">$ grunt lint
</code></pre>
<p>Build the project via</p>
<pre><code class="language-bash">$ grunt build
</code></pre>
<p>The default task, just calling <code>grunt</code> will run <code>build lint test</code>.</p>
<p>If grunt fails, make sure grunt-0.4x is installed: <a href="https://github.com/gruntjs/grunt/wiki/Getting-started">https://github.com/gruntjs/grunt/wiki/Getting-started</a>.</p>
<h2 id="submitting-changes">Submitting Changes <a class="heading-anchor" href="#submitting-changes">#</a></h2>
<ul>
<li>One branch per feature/fix</li>
<li>Follow <a href="http://nodeguide.com/style.html">http://nodeguide.com/style.html</a> (with exception of 100 characters per line)</li>
<li>Please follow <a href="git-commit-msg.html">commit message conventions</a>.</li>
<li>Send a pull request to the <code>master</code> branch.</li>
</ul>
<h2 id="contributor-license-agreement">Contributor License Agreement <a class="heading-anchor" href="#contributor-license-agreement">#</a></h2>
<p>Please sign our Contributor License Agreement (CLA) before sending pull requests.
For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!</p>
<ul>
<li>For individuals we have a <a href="http://code.google.com/legal/individual-cla-v1.0.html">simple click-through form</a>.</li>
<li>For corporations we'll need you to print, sign and one of scan+email, fax or mail <a href="http://code.google.com/legal/corporate-cla-v1.0.html">the form</a>.</li>
</ul>
<h2 id="additional-resources">Additional Resources <a class="heading-anchor" href="#additional-resources">#</a></h2>
<ul>
<li><a href="https://github.com/karma-runner/karma/issues">Issue tracker</a></li>
<li><a href="https://groups.google.com/forum/#!forum/karma-users">Mailing List</a></li>
<li><a href="http://help.github.com/">General GitHub documentation</a></li>
<li><a href="http://help.github.com/send-pull-requests/">GitHub pull request documentation</a></li>
<li><a href="http://twitter.com/JsKarma">@JsKarma</a></li>
</ul>
</div>
</div>
</div>
<div class="push"></div>
</div>
<footer>
<div class="container">
<div class="ten columns"><span class="copyright">
Karma is released under the MIT license.
Site by <a href="https://github.com/Dignifiedquire">Friedel Ziegelmayer</a>. Logo by <a href="http://dribbble.com/isaacdurazo">Isaac Durazo</a>.</span></div>
<div class="six columns">
<div class="social"><a href="https://github.com/karma-runner/karma/" data-tooltip="GitHub Repo"><i class="icon-github-alt icon-large"></i></a><a href="https://github.com/karma-runner/karma/issues" data-tooltip="Issues"><i class="icon-beaker icon-large"></i></a><a href="http://twitter.com/JsKarma" data-tooltip="@JsKarma"><i class="icon-twitter icon-large"></i></a><a href="https://groups.google.com/forum/#!forum/karma-users" data-tooltip="Mailing List"><i class="icon-envelope-alt icon-large"></i></a></div>
</div>
</div>
</footer>
</body>
<!-- Placed at the end of the document so the pages load faster-->
<script src="/assets/js/app.js"></script>
<!-- Google Analytics-->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-46195299-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>