Development Team/API policy - Revision history

FGrose: categorize

2011-11-01T20:05:33Z

categorize

← Older revision		Revision as of 16:05, 1 November 2011
Line 1:		Line 1:
			<noinclude>[[Category:Policy]][[Category:API]]</noinclude>
	== Policy ==		== Policy ==

Patrol: moved Walter is a wanker 12/API policy to Development Team/API policy over redirect: revert

2010-02-24T01:32:53Z

moved Walter is a wanker 12/API policy to Development Team/API policy over redirect: revert

← Older revision	Revision as of 21:32, 23 February 2010
(No difference)

Page move vandal: moved Development Team/API policy to Walter is a wanker 12/API policy: Walter is a wanker

2010-02-24T00:21:09Z

moved Development Team/API policy to Walter is a wanker 12/API policy: Walter is a wanker

← Older revision	Revision as of 20:21, 23 February 2010
(No difference)

Patrol: moved Anal bleaching 15/API policy to Development Team/API policy over redirect: revert

2010-02-21T22:41:47Z

moved Anal bleaching 15/API policy to Development Team/API policy over redirect: revert

← Older revision	Revision as of 18:41, 21 February 2010
(No difference)

Anal bleaching: moved Development Team/API policy to Anal bleaching 15/API policy: Anal bleaching

2010-02-21T22:22:19Z

moved Development Team/API policy to Anal bleaching 15/API policy: Anal bleaching

← Older revision	Revision as of 18:22, 21 February 2010
(No difference)

FGrose: DevelopmentTeam/API policy moved to Development Team/API policy: deCamel casing

2009-03-17T20:44:57Z

DevelopmentTeam/API policy moved to Development Team/API policy: deCamel casing

← Older revision	Revision as of 16:44, 17 March 2009
(No difference)

Marcopg: /* Current state */

2008-10-28T12:18:19Z

Current state

← Older revision		Revision as of 08:18, 28 October 2008
Line 17:		Line 17:
	== Current state ==		== Current state ==

	* Datastore DBus service - STABLE		=== Datastore DBus service ===
	* Presence DBus service - UNSTABLE
	* Window management protocols - UNSTABLE		STABLE.
	* jarabe python package - UNSTABLE
	* sugar python package ~~- detailed in~~ the documentation.		=== Window management protocols ===

			STABLE.

			=== Presence DBus service ===

			UNSTABLE. It was developed in the early Sugar days without a clear idea of the actual requirements. A large part of it is used only by jarabe and will be made internal to it. We have a stable python wrapper which is what most activities uses anyway.

			=== jarabe python package ===

			UNSTABLE. We are working on extensibility of the core components provided by jarabe, but we don't have enough resources to maintain a stable API, nor a clear idea of the requirements yet. We will be moving towards stability but since it's not a basic, essential part of the system, we are punting on it for now.

			=== sugar python package ===

			The state is different for each module. See the documentation for details.

Marcopg: /* Current state */

2008-10-28T12:04:30Z

Current state

← Older revision		Revision as of 08:04, 28 October 2008
Line 17:		Line 17:
	== Current state ==		== Current state ==

	* Datastore DBus service - ~~UNSTABLE~~		* Datastore DBus service - STABLE
	* Presence DBus service - UNSTABLE		* Presence DBus service - UNSTABLE
	* Window management protocols - UNSTABLE		* Window management protocols - UNSTABLE
	* jarabe python package - UNSTABLE		* jarabe python package - UNSTABLE
	* sugar python package - detailed in the documentation.		* sugar python package - detailed in the documentation.

Marcopg: New page: == Policy == Each interface, being a python module, a service or a protocol can be in one of the following states. The state should be always explicitly documented. === Unstable === Cha...

2008-10-28T12:01:21Z

New page: == Policy == Each interface, being a python module, a service or a protocol can be in one of the following states. The state should be always explicitly documented. === Unstable === Cha...

New page

== Policy ==

Each interface, being a python module, a service or a protocol can be in one of the following states. The state should be always explicitly documented.

=== Unstable ===

Changes are possible at any time, except after the feature freeze of each release cycle, but they should be well documented. It should be used for API which requirements are not yet well enough to be able to settle on a stable interface. As Sugar mature we should aim to have as little as possible components in this state.

=== Stable ===

No *incompatible* change is possible. The API should be well documented and a set of unit tests should prevent breakage. To be able to remove a stable interface it will have to first be deprecated.

=== Deprecated ===

Interfaces which are not useful anymore or are being replaced by better, incompatible ones should be deprecated and removed in the next *major* version. When deprecating an interface a replacement should be available and the migration to it well documented.

== Current state ==

* Datastore DBus service - UNSTABLE
* Presence DBus service - UNSTABLE
* Window management protocols - UNSTABLE
* jarabe python package - UNSTABLE
* sugar python package - detailed in the documentation.