Skip to content
Snippets Groups Projects
Commit 24e03d4b authored by Sean Madsen's avatar Sean Madsen
Browse files

lifecycle - using markdown syntax for definition lists

parent 6722fd61
No related branches found
No related tags found
No related merge requests found
...@@ -23,55 +23,94 @@ extensions through the CiviCRM ecosystem. ...@@ -23,55 +23,94 @@ extensions through the CiviCRM ecosystem.
## Definitions ## Definitions
- **Project Maturity**: Should we expect this to work for most users? Should ### Project Maturity
we expect to work in 6 months?
- **Experimental**: An experimental project offers zero support, Should we expect this to work for most users? Should we expect to work in 6
stability, or maintenance. It may be useful for discussion, finding months?
collaborators, or proving a concept.
- **Incubation**: An incubation project offers some degree of support, Experimental
stability, or maintenance. It's probably in use at multiple : An experimental project offers zero support, stability, or maintenance.
organizations. However, the levels are not guaranteed; some gaps and It may be useful for discussion, finding collaborators, or proving a
road bumps should be expected. A project may be "Incubation" for days concept.
or months or years.
- **Stable**: A stable project has undertaken significant efforts to Incubation
ensure that it works and continues working in the future. It has a : An incubation project offers some degree of support,
strong quality-signal. stability, or maintenance. It's probably in use at multiple
- **Deprecated**: The project is no longer being maintained. It may work organizations. However, the levels are not guaranteed; some gaps and
today; but it's liable to break tomorrow (unless someone steps up to road bumps should be expected. A project may be "Incubation" for days
manage it). or months or years.
- **Stewardship**: Who manages a project? Who decides whether the project is
experimental? Or maintained? Or unmaintained? Stable
- **Contributed**: This project is managed by an individual or company in : A stable project has undertaken significant efforts to
the ecosystem. All design, support, and maintenance are at discretion ensure that it works and continues working in the future. It has a
of the original author. strong quality-signal.
- **Official**: The project is monitored as a community resource.
Generally, the original author retains editorial control, but the Deprecated
project receives more strenuous reviews and follows stricter standards : The project is no longer being maintained. It may work
with feedback from others in the community. today; but it's liable to break tomorrow (unless someone steps up to
- **Seeking Maintainer**: This project does not have a person or manage it).
organization responsible for it. If you think the project is useful,
feel free to take responsibility for it. ### Stewardship
- **Support Model**: How do you submit questions and requests about issues?
- **Free**: Submit questions and requests to an open bug-tracker. Who manages a project? Who decides whether the project is experimental? Or
- **Negotiated**: Issues may be reported to open bug-tracker. If the maintained? Or unmaintained?
author agrees it is critical or data-loss, they may address it.
Otherwise, you need to negotiate a contract. Contributed
- **Pre-Paid**: The author will not engage in any support discussions : This project is managed by an individual or company in the ecosystem. All
unless you have pre-paid for support. design, support, and maintenance are at discretion of the original author.
- **Quality Signals**: How do we know if an extension is any good?
- **Self-Assessment**: An author makes a claim about the stability of his Official
work. (This is a low-tech, low-touch process.) : The project is monitored as a community resource.
- **Informal Discussion**: One or more experts give gut reactions. (This Generally, the original author retains editorial control, but the
is a low-tech, high-touch process.) project receives more strenuous reviews and follows stricter standards
- **Formal Review**: One or more experts assesses the quality, with feedback from others in the community.
maintainability, best-practices, etc. using formal criteria. (This is a
low-tech, high-touch process.) Seeking Maintainer
- **Social Metrics**: Data-points (such as #installations or average : This project does not have a person or organization responsible for it.
5-star rating) is collected from many people. (This is a high-tech, If you think the project is useful, feel free to take responsibility for it.
low-touch process.)
- **Technical Metrics**: Technical details (such as test-coverage, ### Support Model
test-results, style-checks, or cyclomatic complexity) are checked by a
bot. (This is a high-tech, low-touch process.) How do you submit questions and requests about issues?
Free
: Submit questions and requests to an open bug-tracker.
Negotiated
: Issues may be reported to open bug-tracker. If the
author agrees it is critical or data-loss, they may address it.
Otherwise, you need to negotiate a contract.
Pre-Paid
: The author will not engage in any support discussions unless you have
pre-paid for support.
### Quality Signals
How do we know if an extension is any good?
Self-Assessment
: An author makes a claim about the stability of his
work. (This is a low-tech, low-touch process.)
Informal Discussion
: One or more experts give gut reactions. (This
is a low-tech, high-touch process.)
Formal Review
: One or more experts assesses the quality,
maintainability, best-practices, etc. using formal criteria. (This is a
low-tech, high-touch process.)
Social Metrics
: Data-points (such as #installations or average
5-star rating) is collected from many people. (This is a high-tech,
low-touch process.)
Technical Metrics
: Technical details (such as test-coverage,
test-results, style-checks, or cyclomatic complexity) are checked by a
bot. (This is a high-tech, low-touch process.)
## Workflow ## Workflow
......
...@@ -8,6 +8,7 @@ extra_javascript: ...@@ -8,6 +8,7 @@ extra_javascript:
markdown_extensions: markdown_extensions:
- markdown.extensions.admonition - markdown.extensions.admonition
- markdown.extensions.attr_list - markdown.extensions.attr_list
- markdown.extensions.def_list
pages: pages:
- Home: index.md - Home: index.md
- Basics: - Basics:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment