mantisbt:howto_submit_patches
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
mantisbt:howto_submit_patches [2007/11/02 14:13] – jreese | mantisbt:howto_submit_patches [2016/09/27 19:46] (current) – Update link for 1.3 dev guide dregad | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Getting your Patches into Mantis ====== | ====== Getting your Patches into Mantis ====== | ||
- | You have identified a bug in a Mantis, and you have developed a solution to correct the defect. So, how do you submit that solution, for inclusion in Mantis? | + | You have identified a bug in a MantisBT, and you have developed a solution to correct the defect. So, how do you submit that solution, for inclusion in MantisBT? |
By following the guidelines set out below, you will give your solution its best chance of being adopted, in a timely fashion. | By following the guidelines set out below, you will give your solution its best chance of being adopted, in a timely fashion. | ||
+ | http:// | ||
- | ===== Base your work on the most current source code ===== | + | Thank you for reading this document -- we look forward to your patches! :-) |
- | Please be sure to base your patch upon the most recent code in our Subversion repository. This ensures you will be able to properly test your modifications and provide a cleanly applicable patch. | ||
- | |||
- | To get the most current Mantis sources use: | ||
- | |||
- | * For the first checkout | ||
- | < | ||
- | svn co https:// | ||
- | </ | ||
- | |||
- | * After the first checkout (run this from the '' | ||
- | < | ||
- | svn update | ||
- | </ | ||
- | |||
- | Please refer to the [[http:// | ||
- | |||
- | ===== Modify and test sources ===== | ||
- | Now you are all set-up to make you modifications to sources. Please be sure to: | ||
- | |||
- | * Follow the [[http:// | ||
- | * Separate each logical change into its own patch. The rule of thumb is: "one patch for one feature or fix". | ||
- | * Test the resulting sources to ensure you patch does what it is supposed to, possibly without breaking other stuff ;) | ||
- | * Make sure your changes do not introduces warnings/ | ||
- | <code php> | ||
- | $g_show_detailed_errors = ON; | ||
- | $g_display_errors = array( | ||
- | E_WARNING => ' | ||
- | E_NOTICE => ' | ||
- | E_USER_ERROR => ' | ||
- | E_USER_WARNING => ' | ||
- | E_USER_NOTICE => ' | ||
- | ); | ||
- | </ | ||
- | * In case of database related changes upgrade the schema so the upgrader works and avoid breaking support for other DBMSes. | ||
- | |||
- | ===== Generate patch file ===== | ||
- | |||
- | Once the modifications are done, you are ready to generate a patch file. This is usually as simple as: | ||
- | |||
- | < | ||
- | |||
- | from the '' | ||
- | |||
- | If your modifications also includes added files, please add the '' | ||
- | |||
- | < | ||
- | |||
- | For non trivial patches, it is recommended to create a zip file which includes the patch created above + all modified and created files. | ||
- | |||
- | ===== Attach to bug report ===== | ||
- | |||
- | Now that the patch is prepared, you now do the following: | ||
- | |||
- | * Report an issue if it doesn' | ||
- | * Attach the patch / zip file. | ||
- | * Attach screen shots and description of what the feature does. | ||
- | * For feature, it really helps to create the Wiki page associated with the issue and start write up the documentation for the feature. | ||
- | |||
- | Since the patch should be reviewed by a Mantis developer, it will help if you also inform the mantisbt-dev mailing list about the available fix. | ||
- | |||
- | Posts on that list from non-subscribers are possible through services like [[http:// | ||
- | |||
- | Thank you for reading this document -- we look forward to your patches! :-) |
mantisbt/howto_submit_patches.1194027209.txt.gz · Last modified: 2008/10/29 04:31 (external edit)