commit 4066095a38f242ef1adbbfcc65078aef8a57232d
Author: Mauro Talevi <[email protected]>
AuthorDate: Mon, 25 Aug 2014 09:31:36 +0200
Commit: Mauro Talevi <[email protected]>
CommitDate: Mon, 25 Aug 2014 09:31:36 +0200
Updated page on how to report issues.
diff --git a/site-frontend/src/site/content/how-to-contribute.html
b/site-frontend/src/site/content/how-to-contribute.html
index 70f98e9..35fa90a 100755
--- a/site-frontend/src/site/content/how-to-contribute.html
+++ b/site-frontend/src/site/content/how-to-contribute.html
@@ -16,13 +16,28 @@
<ol>
<li>Open a new issue on <a
href="http://jira.codehaus.org/browse/JBEHAVE";>JIRA</a> (a Codehaus login can
be created at <a
href="http://xircles.codehaus.org/projects/jbehave";>Xircles</a>).</li>
<li>Clone the <a href="http://github.com/jbehave";> GitHub repo</a> of the
appropriate project.</li>
-<li>Commit your proposed changes to your clone repo, using the issue number
that you created above in the commit message, i.e. start all commits with
"JBEHAVE-xxx:".</li>
+<li>Commit your proposed changes to your cloned repo, using the issue number
that you created above in the commit message, i.e. start all commits with
"JBEHAVE-xxx:".</li>
<li>Update the issue with the links to the commits you made, which can be
easily fetched and cherry-picked using git.</li>
</ol>
<span class="followup">For new ideas or solutions to your specific problems it
is always recommended to first discuss them on the <a
href="mailing-lists.html">mailing-lists</a>,
where you can get the full benefit of the experience of the JBehave community.
It may be that your problem can be already solved using existing
functionality.</span>
+<h2>Reporting Issues</h2>
+
+<p>Users' feedback on issues and bugs is essential and welcome but in order to
be addressed and fixed, the issues need to be reproducible.</p>
+
+<p>To report an issue:</p>
+
+<ol>
+<li>Open a new issue on <a
href="http://jira.codehaus.org/browse/JBEHAVE";>JIRA</a>.</li>
+<li>Provide a <b>self-contained sample project that reproduces your behaviour
via command-line</b> - preferably using Maven but other systems are fine
too.</li>
+<li>The sample project should be sharable either in an archive form (jar, tar,
zip) or - preferably - via your own <a href="http://github.com";>GitHub</a>
repo.</li>
+</ol>
+
+<span class="followup">Please avoid cutting & pasting or attaching bits of
code and configuration to the JIRA issue as it makes it much more cumbersome to
re-compose a
+working project. </span>
+
</body>
</html>
