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
qor-lb
requested review from
a team,
PandaeDo,
aschemmel-tech,
masc2023 and
pahmann
as code owners
github-project-automation
Bot
added this to
S-CORE Roadmap and TLC - Technical Lead Circle
|
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
qor-lb
force-pushed
the
qor-lb_fep_rollout
branch
from
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
qor-lb
force-pushed
the
qor-lb_fep_rollout
branch
from
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
3 participants
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