Code Interface Standards for ArchStudio

These standards have been approved by the ArchStudio Community Consensus Process.
Any changes must be proposed on the archstudio-dev mailing list.

Because ArchStudio is intended to be an extensible environment, external tools will have to be integrated and call various components and services provided by ArchStudio proper. For this to work in a stable manner, some stability will have to be provided by the application programming interfaces (APIs) provided within ArchStudio.

Here, we mean "APIs" broadly - not just to mean the public methods available on any given object or Myx component interface, but also object models, behaviors, and so on.  Evolving Java-based APIs provides a detailed discussion of this topic.

Public APIs, like all new release code, must go through the community consensus process. They must also be minimally documented with Javadoc.

Interfaces must minimally follow the usual Java, Eclipse, and Myx/ArchStudio conventions.

Version-based API Stability

• ArchStudio will have a four-part version number:
  • Major version
  • Minor version
  • Patch version
  • Qualifier

• API changes (other than additions) may be made only in new major or minor releases, not patch releases.

• See also  Eclipse Version Numbering guidelines