-
Notifications
You must be signed in to change notification settings - Fork 447
Streamline RFC process from four stages to a single Proposal stage #2600
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+54
−249
Merged
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
20d9516
Streamline RFC process from four stages to a single Proposal stage
kgeller c826a38
Update CHANGELOG.next.md
kgeller 55e3893
move planned items into steps directly as notes
kgeller 22b56e7
Merge branch 'main' into streamline-rfc-process
kgeller eea8cd1
Update CHANGELOG.next.md
kgeller 65d1927
pr feedback
kgeller 0e93c7a
Merge branch 'streamline-rfc-process' of github.com:kgeller/ecs into …
kgeller 91b2c35
Merge branch 'main' into streamline-rfc-process
kgeller 6295f35
PR feedback
kgeller e844fbc
Merge branch 'streamline-rfc-process' of github.com:kgeller/ecs into …
kgeller 371e979
Update rfcs/0000-rfc-template.md
kgeller 76d2c0f
Update rfcs/README.md
kgeller 8affad2
Merge branch 'main' into streamline-rfc-process
kgeller 0a3af94
promotion clarity
kgeller File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,40 @@ | ||
| # Proposing material changes to ECS | ||
| # Proposing changes to ECS | ||
|
|
||
| Changes to ECS are proposed as Requests for Comments (RFC) in [rfcs/](./) and iterated on through a series of [stages](https://elastic.github.io/ecs/stages.html). To advance to a specific stage, an RFC must meet the documented requirements for that stage. After being accepted into a given stage, there are stage-specific expectations and goals to be met. The overall goal of this process is to thoroughly evaluate and verify the assumptions being made about a change before formally committing it to the schema. | ||
| Changes to ECS are proposed as Requests for Comments (RFCs) in [rfcs/](./). A contributor opens a single **Proposal** pull request that is reviewed holistically by the ECS team. The goal is to thoroughly evaluate and verify the assumptions being made about a change before committing it to the schema. | ||
|
|
||
| Each RFC is represented as a markdown document following a prescribed template that gets committed to the repo. Each stage of the RFC is represented as a pull request against that document. | ||
| Each RFC is a markdown document following the [template](./0000-rfc-template.md). If the RFC proposes new or changed fields, it should also include a corresponding folder in [rfcs/text/](./text/) named with the next available RFC number (check existing folders to find it; any duplicates will be corrected at merge) containing the proposed schema changes as standalone YAML files or extended example mappings and larger source documents. | ||
|
|
||
| If proposing new fields or changing existing fields, the RFC should also have a corresponding folder (named after the RFC number) in [rfcs/text/](./text/). The folder should contain the proposed schema changes as standalone YAML files or extended example mappings and larger source documents. | ||
| ## How a Proposal works | ||
|
|
||
| Generally speaking, the ECS team will help steward the process, but the work of researching and iterating on aspects of an RFC will be owned by that RFC's contributor. If an RFC is being contributed by a community member, then someone at Elastic will need to act as a sponsor of the change to act as a long term owner after completion of the process. The ECS team can help community users with identifying an internal sponsor. If it's not obvious who such a sponsor might be, then the ECS committee will assign a sponsor. | ||
| 1. A contributor copies the [RFC template](./0000-rfc-template.md), fills in all sections, and opens a pull request. | ||
| 2. The contributor specifies a **target maturity** of **alpha** or **beta** for the proposed fields. See [Field stability](../docs/reference/ecs-principles-design.md#_field_stability) for definitions. | ||
| 3. The ECS team reviews the proposal in a single pass, evaluating the key questions below. | ||
| 4. On approval the ECS team merges the PR and assigns a unique RFC number. | ||
|
trisch-me marked this conversation as resolved.
Outdated
|
||
| 5. The proposed fields are added to the schema at the accepted maturity level (by the contributor or the ECS team). This step will be automated in the future so that field definitions are applied to the schema on merge of the Proposal PR. | ||
|
|
||
| ## Key questions we seek to answer through RFC process | ||
| GA promotion is handled separately through the field lifecycle process and does not require a new RFC. In the future, fields will be automatically promoted from beta to GA once an adoption threshold is met. If a proposal is no longer being pursued, the PR is simply closed. | ||
|
trisch-me marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Key questions | ||
|
|
||
| * Is this change appropriate for ECS? | ||
| * Does this change provide enough utility for its intended use cases? | ||
| * Does this change strike a sufficient balance between introducing new fields and reusing existing common fields? | ||
| * Is ownership for the ongoing maintenance of this change clearly defined and accepted? | ||
| * Is the scope of impact of this change to ingestion, existing applications, and the ECS project itself understood? | ||
| * Are the technical details of the change defined clearly enough to implement in the schema? | ||
| * Are we confident these changes can be stable upon release without requiring revisions or breaking changes? | ||
| * Have our assumptions about the shape and utility of these changes been verified by real-world, production-ready usage? | ||
|
|
||
| ## Goals with this contributing process | ||
|
|
||
| * Allow contributors to quickly iterate and receive feedback on their fields in a transparent way without the high bar set for general availability in the schema | ||
| * Clarify the level of stability to expect from a change in ECS while still allowing early adopters to try it out and provide feedback | ||
| * Offer assurance that once an RFC reaches stage 3, we're able to guarantee backward compatibility | ||
|
|
||
| ## Responsibilities in this process | ||
| * Are we confident these changes can be stable at the proposed maturity level? | ||
|
|
||
| Member(s) of the **ECS committee**: | ||
| * evaluates whether the changes are appropriate in terms of the goals of the ECS project | ||
| * provides recommendations on which common fields would be best suited for reuse versus adding new fields | ||
| * determines whether each RFC is accepted into the next target stage by merging the RFC PR | ||
| ## Responsibilities | ||
|
|
||
| The **ECS team**: | ||
| * provides procedural guidance for moving an RFC through stages | ||
| * curates the overall RFC process, including closing stalled or abandoned RFCs | ||
| * reports on the status of open RFCs | ||
| * acts on behalf of the committee for some but not all PRs | ||
| * helps community users identify a sponsor at Elastic | ||
| * evaluate whether the changes are appropriate in terms of the goals of the ECS project | ||
| * provide recommendations on which common fields would be best suited for reuse versus adding new fields | ||
| * determine the accepted maturity level (alpha or beta) and merge the Proposal PR | ||
| * provide procedural guidance for contributors | ||
|
kgeller marked this conversation as resolved.
|
||
| * curate the RFC process, including closing stalled or abandoned RFCs | ||
| * report on the status of open RFCs | ||
|
|
||
| The **contributor**: | ||
| * takes responsibility for doing all necessary legwork to move their RFC forward including but not limited to responding to feedback, identifying and bringing in subject matter experts, and researching the scope of impact | ||
| * demonstrates how the fields in the RFC are expected to be used: from the data source, all the way to its consumption | ||
| * commits to iterating on the RFCs through to stage 3 if necessary | ||
| * creates and iterate on RFC PRs | ||
| * implements all necessary changes to their RFC PRs | ||
|
|
||
| The **sponsor** at Elastic: | ||
| * can be the same person as the contributor if they're someone at Elastic that can take ownership of this change through membership on the ECS committee | ||
| * is involved at least from stage 1 onward if a different person than the contributor | ||
| * signs off on each stage if a different person than the contributor | ||
| * takes or coordinates ownership of the addition in terms of support and maintenance after the RFC process is completed | ||
| * take responsibility for the legwork required to move their RFC forward, including responding to feedback, identifying and bringing in subject matter experts, and researching the scope of impact | ||
| * demonstrate how the proposed fields are expected to be used, from data source through to consumption | ||
| * create and iterate on the Proposal PR | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.