Skip to content

Commit 063391b

Browse files
committed
feat(docs): Experimental Feature process
1 parent 3a6d8f9 commit 063391b

File tree

2 files changed

+96
-0
lines changed

2 files changed

+96
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: 🚀 Experimental Feature Feedback
3+
about: Gather feedback on an experimental feature added to the codebase
4+
type: Feature
5+
---
6+
7+
## Experiment Feature Feedback
8+
9+
### Description of Feature:
10+
...what capabilities does the new feature provide, and why is it needed?
11+
12+
### Feedback Timeline:
13+
- [ ] Publicised at Monthly Working Group Meeting on: [Date]
14+
- [ ] Publicised at Weekly Office Hours on: [Date]
15+
- [ ] Announced on Architecture as Code Mailing List on: [Date]
16+
- [ ] Feedback Period Ends on: [Date]
17+
- [ ] Accepted as non-experimental / Removed from codebase on: [Date]
18+
19+
[Experimental Feature Process](https://github.com/finos/architecture-as-code/tree/main/experimental/)
20+
21+
### Target Project:
22+
...where in the codebase is this feature located (e.g., CLI, calm-hub, calm-widgets, shared utilities, etc.)?
23+
24+
### User Stories:
25+
...describe the feature from an end-user perspective, using "As a [role], I want [feature] so that [benefit]" format...
26+
27+
### Feedback Emphasis:
28+
...what specific areas of the feature are you seeking feedback on? (e.g., usability, performance, edge cases, etc.)
29+
30+
### Current Limitations:
31+
...describe why this functionality isn't possible with the current implementation...
32+
33+
### Implementation Details:
34+
...provide details of the implementation approach, including:
35+
- Technical design considerations
36+
- API changes (if applicable)
37+
- Data model changes (if applicable)
38+
- Dependencies on other components
39+
- New dependencies introduced (if any)
40+
41+
### Additional Context:
42+
...add any other context, diagrams, mockups, or screenshots about the feature here...

experimental/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Experimental modules and features
2+
3+
This folder contains experimental modules and features for CALM.
4+
5+
**These modules and features are not considered stable, and may be subject to change or removal without notice**.
6+
7+
**They are intended for testing and feedback purposes only, and should not be used in production environments.**
8+
9+
**They may not be fully documented, and may have limited support.**
10+
11+
Also note that some experimental feature may reside in other parts of the codebase, and not necessarily in this folder.
12+
13+
## Feedback and acceptance process
14+
15+
When experimental modules or features are added to the CALM codebase, they follow a defined process to be evaluated and
16+
then transitioned to non-experimental status, or removed.
17+
18+
This is to encourage:
19+
20+
- active ownership and development of experimental features
21+
- a defined and recordable feedback flow
22+
- a clean-up of abandoned experimental features
23+
24+
### When an experimental module or feature is added
25+
26+
- an Issue will be created summarising the experimental addition, guiding users on its intended usage, and inviting feedback
27+
- the Issue will specify a defined timeframe for the Feedback Period.
28+
- the timeframe for feedback will be a period of 3 months, measured from the first Monthly Working Group Meeting it is
29+
publicised at.
30+
31+
The Issue should be publicised at:
32+
- mandatorily, a Monthly Working Group Meeting (this is the starting point for measuring the Feedback Period), ideally the first such meeting after the experimental module or feature is merged.
33+
- the next Weekly Office Hours meeting.
34+
- the Architecture as Code mailing list.
35+
36+
### During the Feedback Period
37+
38+
Maintainers will review feedback and potentially act on it to refine the experimental module or feature.
39+
40+
If the experimental module or feature is changed, a maintainer may call to extend the Feedback Period by a month, to
41+
allow for additional feedback on the change. This call should be made at a Weekly Office Hours.
42+
43+
A brief reminder of the experimental module and its feedback Issue should be included at any Monthly Working Group Meetings.
44+
45+
### When the Feedback Period ends
46+
When the feedback period expires a Maintainer vote should take place on the ongoing status of the experiment.
47+
48+
The vote will be between:
49+
50+
- promote the feature to non-experimental
51+
- remove the feature from the codebase
52+
53+
If it is being promoted, then ideally at least two maintainers must be selected for the module. They must be documented
54+
in the repository root's [README.md](../README.md).

0 commit comments

Comments
 (0)