User Tools

Site Tools


checkin_guidelines

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
checkin_guidelines [2008/05/21 15:32]
127.0.0.1 external edit
checkin_guidelines [2018/03/30 06:47]
karl moved into :sourceforge: folder
Line 30: Line 30:
 All checkins should go through at least minimum testing: For source code, this means it compiles and at least a basic test has been done (for example, if it is a new spell, have you tried casting the spell?) This basic testing implies the code at least compiles also. I realize it is very difficult to do 100% testing of code, but at least a basic test should be done. All checkins should go through at least minimum testing: For source code, this means it compiles and at least a basic test has been done (for example, if it is a new spell, have you tried casting the spell?) This basic testing implies the code at least compiles also. I realize it is very difficult to do 100% testing of code, but at least a basic test should be done.
  
-All source code should also be ANSI & POSIX compliant. Don't use // for comments. Be careful of new library calls that are not being used elsewhere in the source - there may be a reason they are not being used. "it compiles on my system"​ is not justification for writing code that does not work elsewhere. It is understandable that you may not know that the code written is non portable, but once this is learned, it should be corrected.+All source code should also be ANSI & POSIX compliant. Don't use **C++ // / / //​**  ​for comments. ​\\ 
 +Be careful of new library calls that are not being used elsewhere in the source ​\\ 
 +- there may be a reason they are not being used. \\ 
 +"It compiles on my system"​ is not justification for writing code that does not work elsewhere. ​\\ 
 +It is understandable that you may not know that the code written is non-portable, ​\\ 
 +but once this is learned, it should be corrected.
  
 For archetypes, this testing should involve rebuilding the arch file and running with the new file. There should be no errors in the loading of the archetype files. For archetypes, this testing should involve rebuilding the arch file and running with the new file. There should be no errors in the loading of the archetype files.