-Introduction -
-Setup -
-Basic Steps to Developing in Mantis +
-Patches +Mantis, an open source project, allows you to contribute changes you make back to the core package. This allows others to benefit from your work and can help you from having to reimplement your chagnes after an upgrade. This page should provide useful information on procedures to ensure development goes smoothly.
-Coding Style +
-Discussion -
-Database -
- -Setup Apache + PHP + MySQL +Install and Setup Apache + PHP + MySQL
-Some site that will do a step by step install and setup.
- +Some site that will guide you through a step by step install and setup. +
-All you really need to do is edit the config.php file to be able to access your mysql installation. Note that you will need to place phpMyAdmin in your web server directory so you can access it with your web browser. In order to secure this you should read the documents and use a .htaccess file. If no one will be accessing your server it's not a big deal; just use your common sense. +All you really need to do is edit the config.php file to be able to access your mysql installation. Note that you will need to place phpMyAdmin in your web server directory so you can access it with your web browser. In order to secure this you should read the documents and use a .htaccess file. If no one will be accessing your server it's not a big deal; just use common sense.
It may complain about magic_quotes_gpc. You can make sure this is on by looking in your php.ini file. Don't forget to restart apache for the settings to take effect. If that doesn't fix the warning just ignore it. I haven't had any problems.
@@ -86,12 +88,12 @@ It may complain about magic_quotes_gpc. You can make sure this is on by looking
You can store your SSH public key on the SF server to avoid having to type your password each access.
-If you're in a unix all you have to do is set the following environment variable: CVS_RSH=ssh +If you are in unix, all you have to do is set the following environment variable: CVS_RSH=ssh
-In bash just: export CVS_RSH=ssh
-In tcsh just: set CVS_RSH ssh
+In bash: export CVS_RSH=ssh
+In tcsh: set CVS_RSH ssh
-TO make this change permanent don't forget to put it in your .bash_profile, profile, .bashrc, .login, or wherever you put your environment variables. Don't forget to relogin! +To make this change permanent don't forget to put it in your .bash_profile, profile, .bashrc, .login, or wherever you put your environment variables. Don't forget to relogin!
If you're in Windows then read the SF documentation for Windows
@@ -105,14 +107,14 @@ Change into the directory and type: "cvs -n update". The -n means no changes.
NOTE: You will have to disable the CVS_RSH=ssh if you want to use that login account for non-SF ssh'ed cvs projects.
-Read the INSTALL directions and configure your config_inc.php file. Install the bugtracker into any database that you would like. If you do a lot of development you will likely be building multiple installations for testing. For example, I have one database called bugtracker as my primary database but also make a new one to test each release (mantis-0-15-1, mantis-0-15-2, etc.). +Read the INSTALL directions and configure your config_inc.php file. Install the bugtracker into any database that you would like. If you do a lot of development you will likely be building multiple installations for testing. For example, I have one database called "bugtracker" as my primary database but also make a new one to test each release (mantis-0-15-1, mantis-0-15-2, etc.).
-Open up your browser and test it out. The bugtracker directory (and any subdirectories) need to be executable. The files will be happy with a chmod of 644. +Open up your browser and test it out. The bugtracker directory (and any subdirectories) need to be world executable. Otherwise you will get errors about access denial or the images will fail to load. The files will be happy with a chmod of 644.
-CVS +
-CVS reference - The key commands are checkout (or co), update, commit (or ci), remove, and add +CVS reference - The key commands to learn are checkout (or co), update, commit (or ci), remove, and add.
Remeber to set your EDITOR environment variable to your favorite command line editor. Otherwise you're likely to get dumped into vi, which is a horrible program to get stuck in for a first time user. To exit, hit ESC then : then q! then ENTER). The last line should look like:
@@ -151,22 +153,32 @@ cvs -n update
- -Development Tips
-
- -
-
+Please follow the Mantis Coding Conventions document. Code not following the convetions will not be accepted! +
+ +
+Discussion and communication should occur in the mailing lists or forums. Any private matters should be directed to me. Please try to keep discussions public. As an open source project much of the value and excitement comes from having an process that is open to the public. +
+ +
+Patches should be appliable using the unix "patch" command. Make sure your .patch or .diff files will be compatible or send explicit instructions on how to apply your changes. Always specify what release you are patching against. +
+ +
+asd +
+ +
MySQL Tips
-PHP Tips +
This is a short crash course in PHP and things that you should take note of when using PHP. @@ -221,7 +233,43 @@ Since php is loosely typed it would try to convert to numbers if you used the +
+ +Rules for Development +
+ +Coding Style +
+Please follow the Mantis Coding Conventions. + +
+CVS commits +
+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. +
+eg. cvs ci -m "Modified view_all_bug page so that column alignment is better across browsers" view_all_bug_page.php3 +
+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. + +
+Communication +
+Please use the mantisbt-dev mailing list or forums. 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. + +
+Testing +
+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. + +
+Other rules +
+Make sure you signup on the bugtracker and received developer access. +
+You can mark a bug as resolved if it is commited in CVS. Please don't close bugs until that release is publicly available. +
+
- -Coding Style -
-Please follow the Mantis Coding Conventions. - -
-CVS commits -
-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. -
-eg. cvs ci -m "Modified view_all_bug page so that column alignment is better across browsers" view_all_bug_page.php3 -
-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. - -
-Communication -
-Please use the mantisbt-dev mailing list or forums. 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. - -
-Testing -
-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. - -
-Other rules -
-Make sure you signup on the bugtracker and received developer access. -
-You can mark a bug as resolved if it is commited in CVS. Please don't close bugs until that release is publicly available. -
- - \ No newline at end of file diff --git a/side_menu.php3 b/side_menu.php3 index c2eb93d..888c796 100644 --- a/side_menu.php3 +++ b/side_menu.php3 @@ -43,6 +43,7 @@
-Basic Steps to Developing in Mantis -
- -Setup Apache + PHP + MySQL -
-
--Some site that will do a step by step install and setup.
- -
-Install phpMyAdmin -
- -
-All you really need to do is edit the config.php file to be able to access your mysql installation. Note that you will need to place phpMyAdmin in your web server directory so you can access it with your web browser. In order to secure this you should read the documents and use a .htaccess file. If no one will be accessing your server it's not a big deal; just use your common sense. -
-It may complain about magic_quotes_gpc. You can make sure this is on by looking in your php.ini file. DOn't forget to restart apache for the settings to take effect. If that doesn't fix the warning just ignore it. I haven't had any problems. -
- -Setup CVS/SSH -
- -
-You can store your SSH public key on the SF server to avoid having to type your password each access. -
-If you're in a unix all you have to do is set the following environment variable: CVS_RSH=ssh -
-In bash just: export CVS_RSH=ssh
-In tcsh just: set CVS_RSH ssh
-
-Don't forget to relogin! -
-If you're in Windows then read the SF documentation for Windows -
-Now checkout the package: -
-cvs -z3 -d <username>@cvs.mantisbt.sourceforge.net:/cvsroot/mantisbt co mantisbt -
-You should now have the latest CVS snapshot. Move this file to somewhere under your web root directory. -
-Change into the directory and type: "cvs -n update". The -n means no changes. It should successfully complete with (probably) no changes. As long as you are in this directory you won't need to type the long access string. -
-NOTE: You will have to disable the CVS_RSH=ssh if you want to use that login account for non-SF cvs projects. -
-Read the INSTALL directions and configure your config_inc.php file. Install the bugtracker into any database that you would like. If you do a lot of development you will likely be building multiple installations for testing. -
-Open up your browser and test it out. The bugtracker directory (and any subdirectories) need to be executable. The files will be happy with a chmod of 644. -
- - -CVS Reference -
-CVS reference - The key commands are checkout (or co), update, commit (or ci), remove, and add -
-Remeber to set your EDITOR environment variable to your favorite command line editor. Otherwise you're likely to get dumped into vi (to exit type ESC then : then q then ENTER). -
-Specify a message on the command line: eg. cvs ci -m "my message" file1 file2 file2.php* *.txt -
- -
- -Help and Reference sites -
-
-
-
- -
-
-
-
-
-
-
- -
- -
- -
- -
- -
- -
-
- -"this plus"." this" is "this plus this"
- -Since php is loosely typed it would try to convert to numbers if you used the + operator.
- -
- -
-