Edgewall Software

Changes between Initial Version and Version 1 of TracDev/ApiChanges


Ignore:
Timestamp:
Jan 23, 2007, 9:47:19 AM (17 years ago)
Author:
Alec Thomas
Comment:

API change guidelines

Legend:

Unmodified
Added
Removed
Modified

  • TracDev/ApiChanges

    v1 v1  
     1= Guidelines on API Changes =
     2
     3 - '''''Always try to maintain API compatibility.'''''
     4 - If an interface ''must'' be changed, try to maintain the old interface for at
     5   least one minor (eg. [milestone:0.10] -> [milestone:0.11]) version change and log deprecation
     6   warnings when it's used. Document the API change in '''!ApiChanges/<version>'''.
     7 - If the old interface can't be maintained, document it as such in the
     8   appropriate '''!ApiChanges/<version>''' Wiki page.