Difference between revisions of "Patches"

From OdaWiki
(Benefits)
 
(8 intermediate revisions by 4 users not shown)
Line 6: Line 6:
  
 
There are some benefits for yourself and others to be gained from submitting a patch:
 
There are some benefits for yourself and others to be gained from submitting a patch:
* Helps ODAMEX in terms of stability and robustness, or maybe adds a new feature that generally making the game more enjoyable to play.
+
* ODAMEX can be made more enjoyable to play and have its stability and robustness improved.
* If you're a newbie developer, it can improve your programming language skills.
+
* If you're a new developer, it can improve your programming language skills.
 
* If you're an advanced developer, it can improve your knowledge of the doom source code.
 
* If you're an advanced developer, it can improve your knowledge of the doom source code.
 
* If you submit several patches, you will be included on the credits/contributors list (and eventually gain developer [[svn]] write access)
 
* If you submit several patches, you will be included on the credits/contributors list (and eventually gain developer [[svn]] write access)
* If you submit big patches, including ones that fix major crashes and or add some feature that makes odamex so much better, you will be granted [[svn]] write access
+
* If you submit big patches such as those that fix major crashes or add a feature that betters Odamex, you will be granted [[svn]] write access.
  
 
==Guidelines for patches==
 
==Guidelines for patches==
  
* Be sure you have the latest [[svn]] revision, just to be sure that you aren't fixing something that has already been fixed.
+
* Be sure you have the latest [[svn]] revision to ensure that you aren't fixing something that has already been fixed.
* Be sure your editor/IDE's EOL mode is LF, not CRLF or CR
+
* Patches must comply with the [[Coding_standard|coding standard]]
  
 
==Sending us a patch==
 
==Sending us a patch==
  
Patch submission can be made using one of the [[MAINTAINERS]] email addresses.
+
Patch submissions can be made by e-mailing one of the [[MAINTAINERS]]
 
+
==Conclusion==
+
 
+
Patches help ODAMEX alot, bugs that the main developers cannot find could be found by you or someone else.
+
Remember, we appreciate patch submission, it is part of the blood that keeps ODAMEX alive
+
  
 
== External Links ==
 
== External Links ==
 
* [http://en.wikipedia.org/wiki/Diff diff utility]
 
* [http://en.wikipedia.org/wiki/Diff diff utility]
 
* [http://en.wikipedia.org/wiki/Patch_%28Unix%29 patch utility]
 
* [http://en.wikipedia.org/wiki/Patch_%28Unix%29 patch utility]

Latest revision as of 00:02, 7 August 2008

Overview

A patch is a portion of source code (fix or addition) that can be directly applied to the main ODAMEX source code.

Benefits

There are some benefits for yourself and others to be gained from submitting a patch:

  • ODAMEX can be made more enjoyable to play and have its stability and robustness improved.
  • If you're a new developer, it can improve your programming language skills.
  • If you're an advanced developer, it can improve your knowledge of the doom source code.
  • If you submit several patches, you will be included on the credits/contributors list (and eventually gain developer svn write access)
  • If you submit big patches such as those that fix major crashes or add a feature that betters Odamex, you will be granted svn write access.

Guidelines for patches

  • Be sure you have the latest svn revision to ensure that you aren't fixing something that has already been fixed.
  • Patches must comply with the coding standard

Sending us a patch

Patch submissions can be made by e-mailing one of the MAINTAINERS

External Links