neyric/wireit

View on GitHub
src/common/docs/contribute.mustache

Summary

Maintainability
Test Coverage
<h2>How to contribute</h2>

<p>Here are some guidelines to help you help us :</p>

<ul>
   <li>Fork the repository on github</li>
   <li>Please write documentation</li>
   <li>Write examples</li>
   <li>Send pull requests from GitHub</li>
</ul>




<h2>Reporting an Issue</h2>

<p>The issues/bugs and feature requests are managed through the <a href="https://github.com/neyric/wireit/issues">GitHub issue tracker</a>. Feel free to add new ones, vote for your favorites, comment on existing one, ...</p>

<p>Then don’t get your hopes up. Unless you have a "Code Red, Mission Critical, The World is Coming to an End" kind of bug, you’re creating this ticket in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the ticket automatically will see any activity or that others will jump to fix it. Creating a ticket like this is mostly to help yourself start on the path of fixing the problem and for others to confirm it with a "I’m having this problem too" comment.</p>


<h2>Contributing to the Documentation</h2>

<p>This guide represents the biggest documentation effort of the library. The <a href="../api/index.html">API documentation</a> is also a huge part of WireIt's documentation. How can you help ?</p>

<ul>
<li>fix typos, spelling</li>
<li>improve code documentation (and therefore the auto-generated API documentation)</li>
<li>write new examples</li>
<li>write about uncovered topics</li>
</ul>

<h2>Contributing to the Code</h2>


<p>You can contribute in a lot of different ways :</p>

<ul>
<li>Design/Styling - images or css</li>
<li>Adapters/backend code</li>
<li>core contributions</li>
</ul>



<h2>Contributors</h2>

<p>Special thanks to the major contributors :</p>

<ul>
<li><a href="https://github.com/neyric">neyric</a> - creator</li>
<li><a href="https://github.com/jamesk">jamesk</a> and <a href="https://github.com/ciaranj">ciaranj</a> - grouping plugin</li>
<li>Barun - Left/Right square Arrow Wire</li>
<li><a href="http://tarpipe.com">Tarpipe</a> - bug fixes, css, images</li>
<li><a href="https://github.com/LeifW">LeifW</a> - bug reports, forum replies</li>
<li><a href="https://github.com/dlitz">dlitz</a> - bug fix</li>
<li><a href="https://github.com/piercus">piercus</a> - bug fix</li>
<li><a href="http://www.jaybyjayfresh.com">Jonathan L.</a> - feature requests, blog post</li>
<li><a href="https://github.com/maximerety">maximerety</a> - major contributor on the inputEx library</li>
</ul>


<h2>Donate</h2>

<p>If you use this project in a commercial application, or simply wish to see this project continue, you can donate on PayPal. Donations will be used for WireIt development and promotion.</p>

<a href='http://www.pledgie.com/campaigns/13031'><img alt='Click here to lend your support to: wireit and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/13031.png?skin_name=chrome' border='0' /></a>