Skip to content
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.

Sign up for GitHub

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

Update CONTRIBUTING doc #2316

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Update CONTRIBUTING doc #2316

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1df5fb
bring CONTRIBUTING doc up-to-date
ebeahan Jan 12, 2024
d73d512
Merge branch 'main' into update-contributing
ebeahan Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,19 +99,10 @@ Please follow these guidelines when submitting Issues:

## Feature freezes and branching

ECS follows a two-stage feature freeze approach using the concepts of Soft Feature Freezes (SFF) and Hard Feature Freezes (HFF).
For an upcoming release, ECS uses a feature freeze (FF) approach. A release branch is cut from `main` for an upcoming
release. When a branch is frozen, changes are limited to bug fixes or doc updates.

Once a branch enters SFF, only minor and low-impact features can be added. The ECS team will rely on the “scope of impact” assessment in the ECS RFC process to help assess the potential impact of a proposed change.

When a branch enters HFF, from that point onward all new features of any size must be contributed to the next ECS version.

For people contributing to the ECS repo, this change means there are two branches at any given time that are accepting at least some sort of feature changes. Here's an example using ECS 8.1:

| Branch | Version | Change scope |
| ------ | ------- | ------------ |
| `main` | 8.2 | Any enhancements or otherwise |
| `8.1` | 8.1 | SFF: Can have low impact enhancements |
| `8.0` | 8.0 | HFF: Only bug fixes, tooling, docs, etc |
Any schema changes or tooling updates will be merged into `main` for the next ECS version.

### Changelogs

Expand Down Expand Up @@ -222,6 +213,12 @@ The [schemas](schemas) directory contains the files which define the Elastic Com

Users consuming ECS to generate something for other use cases should use the `generated/ecs/*.yml` files. More detail can be found [here](generated/README.md).

### Subset Files

The [schemas/subsets](schemas/subsets/) directory contains the configuration to control advanced field nesting use cases.
The config is used with the `--subset` option to control which field sets or specific fields appear in the final generated
artifacts.

## Additional Resources

* [ECS Guidelines and Best Practices](https://www.elastic.co/guide/en/ecs/current/ecs-guidelines.html)
Expand Down
Loading