docs: Roll out DR-002-Proc FEP process across contributor docs#3076
docs: Roll out DR-002-Proc FEP process across contributor docs#3076qor-lb wants to merge 1 commit into
Conversation
|
The created documentation from the pull request is available at: docu-html |
|
|
||
| A proposal classified as **Breaking Change** must additionally include: | ||
|
|
||
| * **Impact Inventory**: explicit list of known integrators, configurations, or customer deliverables that will break |
There was a problem hiding this comment.
How is that related to this template now? https://eclipse-score.github.io/process_description/main/folder_templates/platform/features/feature_name/index.html
There was a problem hiding this comment.
You are right that the Breaking Change section doesnt clearly relate to FR template today, but I think the actual problem might be one level up.
The FR template currently serves two different purposes in one file: proposing a change (Motivation, Backwards Compatibility, Rejected Ideas, Open Issues - point-in-time, argument-for-the-change content) and documenting the resulting feature (Abstract, Rationale, Specification, Security/Safety Impact - living, current-state content).
My intent here (not yet fully reflected/settled): separate these explicitly. A Feature Change / FEP record carries the proposal-only content, including Backwards Compatibility, and lives with the change. Feature Documentation stays in docs/features/ with only Abstract, Rationale, Specification, Security Impact, Safety Impact, kept current as the feature evolves. Some headings would appear in both but ask a different question - e.g. Safety Impact of the feature overall vs. Safety Impact of this specific change - so one wouldnt simply reference the other.
This might be bigger than this PR since it touches FT template, used by every existing feature doc. Genuinely open on this - I would like your/the Process Communities read before committing.
There was a problem hiding this comment.
Added to the agenda of next Community Meeting
https://github.com/orgs/eclipse-score/discussions/2234#discussioncomment-17557191
4ef9140 to
e8953f9
Compare
Implement the consequences of DR-002-Proc (FEP process) across the four affected documents: - feature_request.rst: rewritten as the living FEP Process Guide, superseding the old TL-circle review guideline. Defines roles (Author, Shepherd, Architecture Community), labels, the five process phases with tracking-issue lifecycle, and the FEP template. - change_management.rst: adds FEP routing for Feature and major Feature Modification CRs. - software_architecture_overview.rst: updates references from the old guideline to the FEP Process Guide. - project_management.rst: aligns the Feature Request definition with the FEP tracking issue (type Feature Request, allowed as a parent to child Task issues for implementation tracking). Assisted-by: Claude:claude-sonnet-5
e8953f9 to
1c044ce
Compare
| ```{dec_rec} <Short imperative title> | ||
| :id: dec_rec__<arch|proc|strat|infra|int>__<slug> | ||
| :status: draft | ||
| :tracking: <GitHub issue URL, required once a Shepherd is confirmed> |
There was a problem hiding this comment.
Template can be updated with this new attribute, so finally there should no specific addition, it may also be required in general, will be implemented here, eclipse-score/process_description#744
aschemmel-tech
left a comment
There was a problem hiding this comment.
I have a hard time to understand this, need to re-review at a later time
| This Guideline is based on or references following documents: | ||
| .. _feature_request_guideline: | ||
|
|
||
| This guide describes how to propose a **Feature & Enhancement Proposal (FEP)** in S-CORE. FEPs are |
There was a problem hiding this comment.
propose a proposal?
| :need:`[[title]] <gd_req__change_tool_impact_analysis>` | ||
|
|
||
|
|
||
| The Decision Record Track (FEP Process) |
There was a problem hiding this comment.
Why does it need a new name? Below it is for example termed "FEP track"
aschemmel-tech
left a comment
There was a problem hiding this comment.
now I re-reviewed all
| community needs a structured way to reach agreement before implementation starts, rather than | ||
| relying on a single Committer's review. For these, **Analyze** is specialized into the **FEP | ||
| process**: a Shepherd sponsors the proposal, a time-boxed Final Comment Period | ||
| (silence-as-approval) replaces open-ended review, and the outcome is recorded as a Decision Record |
There was a problem hiding this comment.
maybe better instead "replaces open-ended review" write "fosters quick decision making"
| a judgment call made by the responsible :need:`Committer <rl__committer>` at the time the change is | ||
| proposed, including changes proposed directly as a PR without a prior FEP. A change can be waived | ||
| from the FEP process by community agreement if it is judged not to warrant it, or pulled into the | ||
| FEP process after the fact if a maintainer judges it major. |
There was a problem hiding this comment.
Is the "maintainer" role defined somewhere?
| FEP process after the fact if a maintainer judges it major. | ||
|
|
||
| **Component** and **Component Modification** change requests currently go through the standard | ||
| Analyze step and are not routed onto the FEP track. |
There was a problem hiding this comment.
Is this true? I understood it differently when I was talking to @masc2023
|
|
||
| For Change Requests routed onto the :ref:`Decision Record Track <change_mgmt_plan>`, this step is | ||
| performed as described in the :ref:`FEP Process Guide <feature_request_guideline>` instead: a | ||
| Shepherd, not a single Committer, guides the analysis, and the review window is the time-boxed |
There was a problem hiding this comment.
the "review window"? Maybe "the review ends in the time-boxed Final Comment Period and not in an open-ended "in review" state?
| .. _feature_request_guideline: | ||
|
|
||
| This guide describes how to propose a **Feature & Enhancement Proposal (FEP)** in S-CORE. FEPs are | ||
| not a separate change process: they specialize the Analyze step of the standard Change Request |
There was a problem hiding this comment.
bettter describe what they are: "a part of the change process (see link) and they refine the Analyze step..."
| <change_mgmt_plan>` — for *Feature* change requests and *Feature Modification* change requests with | ||
| major impact, for example changes affecting the platform or other Feature Teams. | ||
|
|
||
| It supersedes the previous ad hoc Feature Request review (GitHub label plus weekly Technical Lead |
There was a problem hiding this comment.
I would rather describe only what is and not what it supersedes.
|
|
||
| Feature Request Guideline | ||
| ############################## | ||
| Feature & Enhancement Proposal (FEP) Process |
There was a problem hiding this comment.
Note that the "parent document" docs/contribute/contribution_request/index.rst talks about "Feature Requests are the heart of our evolution" - maybe add there also a reference to the "FEP Process"
Implements the consequences of DR-002-Proc (accepted), which introducesthe Feature & Enhancement Proposal (FEP) process for Feature and major Feature Modification change requests.
Changes:
feature_request.rstrewritten as the living FEP Process Guide, superseding the old TL-circle review guideline: roles, labels, the five process phases with tracking-issue lifecycle, and the FEP template.change_management.rst: FEP routing added for Feature and major Feature Modification CRs.software_architecture_overview.rst: references updated to the FEP Process Guide.project_management.rst: Feature Request definition aligned with the FEP tracking issue (type Feature Request, may parent child Task issues for implementation tracking).See DR-002-Proc for the decision and rationale.
Refs #3061