CONTRIBUTING.html

<h1>JBoss AS Quickstarts</h1>
<p>Quickstarts (or examples, or samples) for JBoss AS. There are a number of rules for quickstarts:</p>
<ul>
<li>Each quickstart should have a unique name, this enables a user to quickly identify each quickstart</li>
<li>A quickstart should have a simple build that the user can quickly understand. If using maven it should:</li>
<li>Not inherit from another POM</li>
<li>Import the various BOMs from AS7 APIs to get version numbers</li>
<li>Use the JBoss AS Maven Plugin to deploy the example</li>
<li>The quickstart should be importable into JBoss Tools and deployable there</li>
<li>The quickstart should be explained in detail in the associated user guide, including how to deploy</li>
<li>If you add a quickstart, don't forget to update <code>dist/src/main/assembly/README.md</code> and <code>pom.xml</code> (the 'modules' section).</li>
</ul>
<p>You can find the documentation at <a href="https://docs.jboss.org/author/display/AS7/Documentation">https://docs.jboss.org/author/display/AS7/Documentation</a>.</p>
<p>If you add a quickstart, don't forget to update <code>dist/src/main/assembly/README.md</code>.</p>
<p>The 'dist' folder contains Maven scripts to build a zip of the quickstarts.</p>
<p>The quickstart code is licensed under the Apache License, Version 2.0:
<a href="http://www.apache.org/licenses/LICENSE-2.0.html">http://www.apache.org/licenses/LICENSE-2.0.html</a></p>