4,400
edits
(Out of date) |
m (moved Howto: Submit patches to Howto:Submit patches: Robot: Moved page) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
== Guidelines == | |||
== | |||
Any invasive or non-trivial patches should preferably adhere to the following recommendations: | Any invasive or non-trivial patches should preferably adhere to the following recommendations: | ||
* Search the [http://sourceforge.net/mailarchive/forum.php?forum_name=flightgear-devel flightgear-devel list archives] ([http://www.flightgear.org/mail.html old]) for any relevant discussion and then post to the flightgear-devel [[mailing list]] describing your idea and discussing the scope of effort required. | * Search the [http://sourceforge.net/mailarchive/forum.php?forum_name=flightgear-devel flightgear-devel list archives] ([http://www.flightgear.org/mail.html old]) for any relevant discussion and then post to the flightgear-devel [[mailing list]] describing your idea and discussing the scope of effort required. | ||
* If you have developed several different features, make sure '''not''' to provide one big patch for all of these changes, but instead several smaller ones for each individual feature (likewise, use separate threads on the mailing list as well), that way you will enable developers to easily and independently review/discuss your patches [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg16986.html]. | |||
* | |||
* Try to make your patch optionally minimally invasive: | * Try to make your patch optionally minimally invasive: | ||
Line 27: | Line 21: | ||
* If you need to print output to the terminal, make sure to use the SG_LOG logging mechanism, using the appropriate log level. Use this command sparingly, as excessive logging information has negative impact on framerate, especially on some platforms (you can however easily use switches to generally enable/disable output of debugging information). When committing a patch, make sure you have either removed or commented out any cout or cerr statements that you have used during private debugging sessions. | * If you need to print output to the terminal, make sure to use the SG_LOG logging mechanism, using the appropriate log level. Use this command sparingly, as excessive logging information has negative impact on framerate, especially on some platforms (you can however easily use switches to generally enable/disable output of debugging information). When committing a patch, make sure you have either removed or commented out any cout or cerr statements that you have used during private debugging sessions. | ||
== Howto create and share patches == | |||
{{Main article|Merge request}} | |||
[[Category:Development]] | [[Category:Development]] |