commit 6d7797ce2b8ff057ced58d78268c8a2027513b1c
Author: Mauro Talevi <[email protected]>
AuthorDate: Wed Apr 25 14:09:12 2012 +0200
Commit: Mauro Talevi <[email protected]>
CommitDate: Wed Apr 25 14:09:12 2012 +0200
JBEHAVE-768: Added doc page on how to contribute.
diff --git a/distribution/src/site/content/how-to-contribute.html
b/distribution/src/site/content/how-to-contribute.html
new file mode 100755
index 0000000..c86327d
--- /dev/null
+++ b/distribution/src/site/content/how-to-contribute.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+<html>
+<head>
+ <title>How to Contribute</title>
+</head>
+<body>
+
+<h2>Contributing to JBehave</h2>
+
+<p>An open-source project thrives on users' contributions. We welcome all
contributions, from new features to enhancements and bugfixes.</p>
+
+<p>To propose a contribution: </p>
+
+<ol>
+<li>Open a new issue on the <a href="issue-tracking.html">issue
tracking</a>.</li>
+<li>Clone the GitHub repo on <a href="source-repository.html">source
repository</a>.</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>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>
+
+</body>
+
+</html>
diff --git a/distribution/src/site/content/issue-tracking.html
b/distribution/src/site/content/issue-tracking.html
index f59e0c1..4e12bc6 100755
--- a/distribution/src/site/content/issue-tracking.html
+++ b/distribution/src/site/content/issue-tracking.html
@@ -13,6 +13,8 @@
<p>We welcome user input in driving our development priorities. You can
suggest new features or enhancements to an existing ones.</p>
+<p>Please refer to <a href="how-to-contribute.html">how to contribute</a> for
the recommended process of contribution.</p>
+
</body>
</html>
diff --git a/distribution/src/site/content/sitemap.xml
b/distribution/src/site/content/sitemap.xml
index 1297649..3789d5a 100755
--- a/distribution/src/site/content/sitemap.xml
+++ b/distribution/src/site/content/sitemap.xml
@@ -4,6 +4,7 @@
<page>index.html</page>
<page>features.html</page>
<page>getting-started.html</page>
+ <page>how-to-contribute.html</page>
<page>dependencies.html</page>
<page>faq.html</page>
<page>license.html</page>
diff --git a/distribution/src/site/content/stories-in-your-language.html
b/distribution/src/site/content/stories-in-your-language.html
index 37c30ab..dadcd57 100755
--- a/distribution/src/site/content/stories-in-your-language.html
+++ b/distribution/src/site/content/stories-in-your-language.html
@@ -143,14 +143,15 @@ You can verify which language is supported by looking at
the <b>i18n/</b>
directory in the <b>jbehave-core-resources.zip</b>. If you'd like your
language to be supported, you can contribute the keywords in that
language and we'll happily add the language to the list of those
-supported out-of-the-box.</p>
+supported out-of-the-box, see <a href="how-to-contribute.html">how to
contribute</a>.</p>
<span class="followup">Note that Java resource bundles require
non-English language characters to be expressed as Unicode escaped
characters (of the form \uxxxx where xxxx is 4-digit Hexadecimal
number), using ISO-8859-1 encoding. There are a number of tools that
enable easy conversion between your non-English language characters and
-Unicode escaped characters. </span>
+Unicode escaped characters. A useful web-based tool for conversion to Unicode
escaped
+characters is <a
href="http://www.htmlescape.net/javaescape_tool.html";>javaescape_tool</a>.</span>
<h2>How do I provide my own keywords bundle?</h2>
