Commit Graph

9 Commits

Author SHA1 Message Date
Christos Markou 2e615287a4
[chore] Update contributing docs with SemConv compatibility guideline (#13101)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR adds a guideline about how metrics'/attributes' addition should
take place in (some) coordination with the Semantic Conventions project.
This addition does not introduce a hard requirement for now but rather
suggests how such coordination with Semantic Conventions can be
achieved.

If this gets merged I plan to extend Contrib's guidelines as well (i.e.
84f1030339/CONTRIBUTING.md (adding-metrics-to-existing-receivers))
to link back to this guideline.

<!-- Issue number if applicable -->
#### Link to tracking issue
Part of
https://github.com/open-telemetry/opentelemetry-collector/issues/13076

/cc @open-telemetry/collector-contrib-approvers
@open-telemetry/collector-approvers

Note: It's still to be defined how Semantic Conventions will affect
components' stability as described at
https://github.com/open-telemetry/opentelemetry-collector/issues/11878,
however prior to the stability concern this PR suggests to update our
contribution guidelines to cover for this treating it as a "soft"
requirement already.

---------

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
2025-06-02 10:11:55 +00:00
Pablo Baeyens 8c24854960
[chore] Add naming guidance for modules prefix (#12479)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

Add guidelines for naming Go modules
2025-02-25 22:40:14 +00:00
Pablo Baeyens c713e7c4d7
[chore][docs] Add guidance regarding breaking changes (#12274)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Reworks breaking changes section to include information about our
approach to feature gates.

---------

Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
2025-02-14 11:40:48 +00:00
Pablo Baeyens 1041a0be80
[chore][docs] Use consistent title hierarchy (#12272)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Use h2 (hN-1) titles for h2 (hN-1) sections instead of h3 (hN)
2025-02-04 16:39:08 +00:00
Pablo Baeyens 1e5ccbecd8
[chore] Document module split in more detail (#11860)
<!--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 <jade.guiton@datadoghq.com>
2024-12-23 16:37:55 +00:00
Dmitrii Anoshin 4a987da6c5
[docs] Add guidelines for experimental modules naming (#11836)
Adding guidelines for experimental module naming as a result of [the
vote](https://github.com/open-telemetry/opentelemetry-collector/issues/11783).

Resolves #11783
2024-12-11 16:26:23 +00:00
Pablo Baeyens 37184b0b3f
[chore][docs] Move configuration changes guidelines to component stability doc (#11572)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->
Works towards #11553. Unifies information about component stability in a
single document.

#### Link to tracking issue
Fixes #11571
2024-10-30 15:55:05 +01:00
Pablo Baeyens 39f714b442
[chore][docs] Reflect current practices about configuration structs in coding guidelines (#11549)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Reflects existing practice in coding guidelines.

#### Link to tracking issue

Relates to #6767, fixes #9428
2024-10-29 10:59:30 +01:00
Pablo Baeyens f2b31d131a
[chore][CONTRIBUTING.md] Move coding guidelines to separate document (#11484)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Moves coding guidelines to a separate document where we can work on
expanding them. This is the largest part of the contributing document
and it was making it a bit difficult to work with and scary-looking for
newcomers.
2024-10-21 11:39:51 +02:00