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.

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

[CONTRIBUTING.md] Add section about merging ECS conventions #333

Merged
merged 22 commits into from
Dec 15, 2023
Merged
Changes from 4 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
30b2a6b
[CONTRIBUTING.md] Add section about merging ECS conventions
mx-psi Sep 20, 2023
52c0860
Rename to 'soft recommendations'
mx-psi Sep 21, 2023
af694df
Fix markdownlint
mx-psi Sep 25, 2023
2010d3f
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Sep 26, 2023
68709a0
Explicitly add prior work on another standard as acceptable evidence
mx-psi Oct 5, 2023
89417cd
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Oct 5, 2023
a85ef7c
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Oct 9, 2023
e86a7f0
Address feedback
mx-psi Oct 13, 2023
bd66803
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Oct 13, 2023
331e7ca
Linting
mx-psi Oct 13, 2023
b7f14b1
Apply suggestions from code review
mx-psi Oct 13, 2023
e3d5103
Merge branch 'main' into mx-psi/ecs-conventions
AlexanderWert Oct 16, 2023
9d94ca1
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Oct 25, 2023
223602b
Merge branch 'main' into mx-psi/ecs-conventions
joaopgrassi Nov 14, 2023
ab996cd
Merge remote-tracking branch 'upstream/main' into mx-psi/ecs-conventions
mx-psi Nov 29, 2023
5b69fe2
Address feedback
mx-psi Nov 29, 2023
383c269
Make linter happy
mx-psi Nov 29, 2023
fccfd87
Merge branch 'main' into mx-psi/ecs-conventions
joaopgrassi Dec 4, 2023
e34be16
Apply suggestions from code review
mx-psi Dec 11, 2023
6b20de2
Merge branch 'main' into mx-psi/ecs-conventions
mx-psi Dec 11, 2023
1ee4524
Merge branch 'main' into mx-psi/ecs-conventions
AlexanderWert Dec 14, 2023
71c2e80
Merge branch 'main' into mx-psi/ecs-conventions
AlexanderWert Dec 15, 2023
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
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,21 @@ make misspell-correction
- Send staging tag as PR for review.
- Create a tag `v{version}` on the merged PR and push remote.

## Merging existing ECS conventions

The Elastic Common Schema (ECS) is being merged into OpenTelemetry Semantic
Conventions per [OTEP 222][otep222]. When adding a semantic convention that
exists in some form in ECS, consider the following guidelines:

- Prefer using the existing ECS name when possible. In particular:
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
- Do not amend ECS names to follow plural guidelines or other soft
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
recommendations.
- If proposing a name that differs from the ECS convention, provide usage
data, user issue reports or feature requests or comparable evidence about
the alternatives.
- Do not use an existing ECS name as a namespace. If the name must differ, use a
different namespace name to avoid clashes or avoid using the namespace
entirely.
mx-psi marked this conversation as resolved.
Show resolved Hide resolved

[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
[otep222]: https://github.com/open-telemetry/oteps/pull/222
mx-psi marked this conversation as resolved.
Show resolved Hide resolved
Loading