Note | ||||||
---|---|---|---|---|---|---|
Document status:
|
Contents
Table of Contents | ||
---|---|---|
|
Context and objective
This document is a working draft for a recommendation of what a "1.0 Stable" version of a Symphony API Language Binding should cover. The goal is that new language bindings have a central document to orient themselves when starting the project, and that projects that are getting close to "1.0 Stable" release have a checklist they can use to finalize.
The primary focus is to allow users of such SDKs to be very clear on what to expect when starting to build on them. This would cover both functional and non-functional expectations.
Current projects recap
SDK | Project | Status | Project owner | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Java | V1.0.0 (SNAPSHOT) | |||||||||||
.NET | 0.4.0 | |||||||||||
Python | ||||||||||||
Clojure | 0.1.0 | Peter Monks | ||||||||||
PHP |
| Florian de Miramon |
Users expectations
As users of a "1.0" SDK, I would expect the following:
...
More precisely, this means:
Readiness checklist
- Foundation contribution criteria
- Active status: see Activation
- Functional coverage meets, at time of release
- 0 Blockers on any functions
- 0 Critical on any functions
- 0 Major on any functions
- Need to discuss specific criticality definition
- Non-functional definition
- Need to discuss what we recommend here, notably regarding:
- load balancing, HA
- supported topologies
- performance/latency
- Need to discuss what we recommend here, notably regarding:
- Functional integrity
- Other WG members/LLC to perform deep dive
- LLC to publish Set Presence endpoint
- Documentation integrity
- LLC to add SDK documentation into https://developers.symphony.com/ (or equivalent)
Launch activities
- All users of the Symphony Platform should be made aware of this significant milestone. For example:
- Outreach to dev@symphony.foundation
- Outreach to Symphony LLC customers
- Other media (eg Twitter)