Add a contribute page

[plack-app-gruntmaster.git] / a / contribute.en

diff --git a/a/contribute.en b/a/contribute.en
new file mode 100644 (file)
index 0000000..b7c0411
--- /dev/null
+++ b/a/contribute.en
@@ -0,0 +1,23 @@
+<h1>Reporting bugs</h1>
+Please report any bugs you find to the <a href="https://bugs.ieval.ro/">bugtracker</a>.
+
+<h1>Source code repositories</h1>
+The Gruntmaster 6000 project has three git repositories:
+<dl>
+<dt><a href="https://git.ieval.ro/?p=gruntmaster-data.git">gruntmaster-data</a></dt>
+<dd>The database interface and database editing tools</dd>
+<dt><a href="https://git.ieval.ro/?p=gruntmaster-daemon.git">gruntmaster-daemon</a></dt>
+<dd>The grader</dd>
+<dt><a href="https://git.ieval.ro/?p=gruntmaster-page.git">gruntmaster-page</a></dt>
+<dd>The website</dd>
+
+<h1>Submitting patches</h1>
+Mail them to <a href="mailto:marius@ieval.ro">marius@ieval.ro</a>. Please try to follow the following guidelines:
+<ul>
+<li>Patch against master (or, alternatively, against newmc for gruntmaster-page)
+<li>Many small commits are better than one big commit
+<li>Make the commit messages as clear as possible
+<li>If possible, please include an explanation of the patchset in the email
+</ul>
+
+If you have any questions, feel free to mail them to <a href="mailto:marius@ieval.ro">marius@ieval.ro</a> or to ask in <a href="http://webchat.oftc.net/?channels=%23mindcoding">#mindcoding</a> on OFTC.