CONTRIBUTING.html

<h1 id="contributing">CONTRIBUTING</h1>

<h2 id="issue-tracker">Issue tracker</h2>

<p>We've chosen JIRA as our issue tracker, so please use https://issues.jboss.org/browse/ORG project to submit feature requests, bugs etc. </p>

<h3 id="viewing-open-issues">Viewing open issues</h3>

<p>You can see open issues by browsing <a href="https://issues.jboss.org/browse/ORG/component/12315680#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponent-issues-panel">'www.jboss.org (Awestruct)' JIRA component</a>.</p>

<h3 id="creating-an-issue">Creating an issue</h3>
<ul>
  <li>It's very important to set 'www.jboss.org (Awestruct)' JIRA component for the created issue. Otherwise it might not be noticed among many tasks of other jboss.org subprojects.</li>
  <li>Please remember to add a link to Git Pull Request if your issue is related to a one.</li>
</ul>

<h2 id="submitting-pull-requests">Submitting pull requests</h2>

<p>When adding new features it is important for you to follow the standard Github conventions with addition of creating a JIRA issue:</p>

<ol>
  <li>Fork the project</li>
  <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
  <li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
  <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
  <li>Create new Pull Request</li>
  <li>Link the Pull Request in related JIRA issue or create a new one with description. Our JIRA has a specific field for Git Pull Request link.</li>
</ol>

<p>For more detailed instructions, read <a href="https://help.github.com/articles/creating-a-pull-request">this article on Github Help</a>.</p>