Skip to content

Commit

Permalink
Added rules.php3 for developer guidelines
Browse files Browse the repository at this point in the history
git-svn-id: http://mantisbt.svn.sourceforge.net/svnroot/mantisbt/trunk@511 f5dc347c-c33d-0410-90a0-b07cc1902cb9
  • Loading branch information
prescience committed Nov 19, 2001
1 parent 60fdfbb commit 7188b1f
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
2 changes: 1 addition & 1 deletion cvs.php3
Expand Up @@ -2,7 +2,7 @@

<span class="page_title">CVS</span>
<p>
Mantis uses <a href="http://www.cyclic.com/">CVS</a> to store and control its source code. Anonymous cvs access allows anyone to download the most current snapshot of the code. Warning: the latest build may not always function correctly. I will <b>*not*</b> support CVS snapshots. Only use this is you feel confident in being able to deal with any problems that will arise.
Mantis uses <a href="http://www.cyclic.com/">CVS</a> to store and control its source code. Anonymous cvs access allows anyone to download the most current snapshot of the code. Warning: the latest build may not always function correctly. I will <b>*not*</b> support CVS snapshots. Only use this if you feel confident dealing with any problems that arise.
<p>
Follow the link and follow the commands there. The module name you want to use is <i>mantisbt</i>.
<p>
Expand Down
38 changes: 38 additions & 0 deletions rules.php3
@@ -0,0 +1,38 @@
<? include( "top.php3" ); ?>

<span class="page_title">Rules for Development</span>
<hr size=1 noshade width="100%">
<p>

<span class="section">Coding Style</span>
<p>
Please follow the <a href="guidelines.php3">Mantis Coding Conventions</a>.

<p>
<span class="section">CVS commits</span>
<p>
Please keep comits short and focused. Ideally you would check in all the files affects by your change(s) at one time. You should try to commit after every bugfix or feature addition. Make sure your commit note tells enough so that another developer (familiar with the project) can make sense of what changes were made. Information might include files, functions, and variables that were modified.
<p>
eg. cvs ci -m "Modified view_all_bug page so that column alignment is better across browsers" view_all_bug_page.php3
<p>
Occasionally you can make do with a trivial message like "updates for release" or "tweaked formatting". This might be when you update the Changelog, or reformatted and cleaned up code, etc.

<p>
<span class="section">Communication</span>
<p>
Please use the <a href="mailinglists.php3">mantisbt-dev mailing list</a> or <a href="forums.php3">forums</a>. You can monitor forums so that every post is emailed to you. This way there is a public record of development. If you have a matter you would like to discuss in private them emailing me directly is fine.

<p>
<span class="section">Testing</span>
<p>
In general I would prefer that you test using at least two browsers. This way most browser dependencies can be caught. I recommend testing with Internet Explorer and Mozilla. This captures the vast majority of actual users. Others that might be considered are Opera, Netscape, Konqueror, and OmniWeb.

<p>
<span class="section">Other rules</span>
<p>
Make sure you signup on the bugtracker and received developer access.
<p>
You can mark a bug as resolved if it is commited in CVS. Please don't close bugs until that release is publicly available.
<p>

<? include( "bot.php3" ); ?>
1 change: 1 addition & 0 deletions side_menu.php3
Expand Up @@ -112,6 +112,7 @@
<td class="menu_items">
<a href="starting.php3">Getting Started</a><br>
<a href="guidelines.php3">Coding Guidelines</a><br>
<a href="rules.php3">Developer Rules</a><br>
<a href="devnotes.php3">Dev Notes</a><br>
<a href="roadmap.php3">Roadmap</a><br>
<a href="polls.php3">Polls</a><br>
Expand Down

0 comments on commit 7188b1f

Please sign in to comment.