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

Jump to bottom

Document best practice regarding experimental modules #11436

Closed
mx-psi opened this issue Oct 14, 2024 · 0 comments · Fixed by #11860
Closed

Document best practice regarding experimental modules #11436

mx-psi opened this issue Oct 14, 2024 · 0 comments · Fixed by #11860
Milestone
go.opentelemetry....

Comments

@mx-psi
Copy link
Member

mx-psi commented Oct 14, 2024

Some modules are experimental and will continue to be experimental even after we declare the parent module 1.0:

We may want to merge these modules back into the parent module when the versions match, so that these modules become packages instead of separate modules. We should document what the best practice regarding this is.
@mx-psi mx-psi mentioned this issue Nov 4, 2024
Open
@mx-psi mx-psi mentioned this issue Dec 12, 2024
Merged
@mx-psi mx-psi moved this from In Progress to Waiting for reviews in Collector: v1 Dec 18, 2024
github-merge-queue bot pushed a commit that referenced this issue Dec 23, 2024
@mx-psi @jade-guiton-dd
[chore] Document module split in more detail (#11860)
1e5ccbe 
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

- Documents when to split into separate modules, including general rules
as well as specific conventions we are currently using
- Rephrases the wording on #11836 to add it into a general list.
- Documents how to split into separate modules.

<!-- Issue number if applicable -->
#### Link to tracking issue
Follows #11836, Fixes #11436, Fixes #11623

---------

Co-authored-by: Jade Guiton <[email protected]>
@github-project-automation github-project-automation bot moved this from Waiting for reviews to Done in Collector: v1 Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Collector: v1
Archived in project
Milestone
go.opentelemetry.io/collector/compone...
Development

Successfully merging a pull request may close this issue.

[chore] Document module split in more detail mx-psi/opentelemetry-collector
2 participants
@mx-psi @songy23