Skip to content

Commit

Permalink
Merge pull request #619 from boidolr/update_contributing_docs
Browse files Browse the repository at this point in the history
Update contribution guidelines
  • Loading branch information
javve authored Dec 16, 2018
2 parents 8cdcf98 + 908b0b5 commit 6242496
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 66 deletions.
58 changes: 0 additions & 58 deletions __test__/index.html

This file was deleted.

16 changes: 8 additions & 8 deletions docs/overview/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@

<h2>Setup environment</h2>
<h4>1. Install Node.js</h4>
<p>Go to <a href="http://nodejs.org/">Nodejs.org</a></p>
<p>Go to <a href="https://nodejs.org/">Nodejs.org</a></p>

<h4>2. Install dependencies</h4>
<pre><code>npm install</code></pre>

<h2>Compile and test</h2>
<h4>Compile the script <code>(build/build.js)</code></h4>
<pre><code>grunt</code></pre>
<h4>Compile the script <code>(webpack.config.js)</code></h4>
<pre><code>npx webpack</code></pre>

<h4>Watch and recompile when files change</h4>
<pre><code>grunt watch</code></pre>
<pre><code>npx webpack --watch</code></pre>

<h4>Create standalone List.js <code>(dist/list.js)</code></h4>
<pre><code>grunt dist</code></pre>
<pre><code>npx webpack --production</code></pre>

<h4>Run the test suite</h4>
<pre><code>grunt test</code></pre>
<p>Or open this file your browser</p>
<pre><code>/test/index.html</code></pre>
<pre><code>npx jest</code></pre>
<p>Run tests continuously when files change</p>
<pre><code>npx jest --watch</code></pre>

<h2>Guidelines for making pull requests</h2>
<ul>
Expand Down

0 comments on commit 6242496

Please sign in to comment.