-
Notifications
You must be signed in to change notification settings - Fork 77
Platform Maturity and Criteria
enikao edited this page Jun 2, 2016
·
4 revisions
We distinguish the following levels of maturity in mbeddr Platform:
- Meets the Criteria below
- Will be maintained
- Will stay stable
- No incompatible changes
- Or, (preferably automated) migration path
- Can be expected to "just work"
- Not yet as mature as Stable
- Aims to get there
- Won't stay in Staging forever -- either develops to be Stable or drops out
- Maximum time in Staging: 3 months
- Everything required in the platform for historic reasons, but not meeting the criteria above
- No guarantees whatsoever (might be deleted, reworked, changed, ... in the future)
In order to move from "big collection of interesting parts of unknown maturity" to Future Criteria, we introduce Transitional Criteria. Stable Platform elements should strive to meet Future Criteria, but are sufficient to meet Transitional Criteria up until 2016-12-31. Platform elements not meeting Future Criteria after this date will be considered Staging.
- No log or other unintentional output
- All dependencies met, no unnecessary dependencies
- Only unavoidable (i. e. false positive) errors / warnings / infos in model check on all models (including languages, solutions)
- No code duplication
- No exceptions thrown / visible at normal operations
- Code, tests, documentation, and examples are added to the appropriate automated builds
- Works when used from or available in
- source model
- project library
- IDEA plugin
- Examples available for common uses
- Pointer to examples for self-explanatory cases
- At least brief description for complex cases
- Used in at least two Consultings, Projects, Products
- Adheres to Development Guide
- No log or other unintentional output
- All dependencies met, no unnecessary dependencies
- Only unavoidable (i. e. false positive) errors / warnings / infos in model check (including languages, solutions, tests, documentation, examples, generators)
- No code duplication
- No exceptions thrown / visible at normal operations
- Code, tests, documentation, and examples are added to the appropriate automated builds
- Works when used from or available in
- source model
- project library
- application library
- IDEA plugin
- IDEA plugin with stripped models
- If all tests are green we need to be sure it works
- Maybe exception for UI-heavy stuff (hard to test)
- All user-facing features and options are documented, preferably in mbeddr doc language and integrated with documentation aspect
- Pointer to examples is sufficient for self-explanatory cases
- Examples available for all user-facing features and options
- At least two people know and understand the implementation
- Used in at least two Consultings, Projects, Products
- Adheres to Development Guide