Skip to content

[Repo] Update contributing guide for new projects #4311

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

Merged
martincostello merged 1 commit into from
Apr 28, 2026
Merged

[Repo] Update contributing guide for new projects #4311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,12 @@ shipped through CI.
added the `OpenTelemetry.Instrumentation.Kusto` project:
[#4041](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/4041).

* The NuGet package and project's name must start with `OpenTelemetry.`.
"Namespaces" are used to group similar components together. For example, all
instrumentation libraries are grouped under `OpenTelemetry.Instrumentation.*`
and all exporters are grouped under `OpenTelemetry.Exporter.*`. Choose an
appropriate name for your project based on this convention.

* Based on what your project is, you may need to depend on the [OpenTelemetry
SDK](https://www.nuget.org/packages/OpenTelemetry) or the [OpenTelemetry
API](https://www.nuget.org/packages/OpenTelemetry.Api) Include the necessary
Expand All @@ -268,7 +274,7 @@ shipped through CI.
</ItemGroup>
```

* The assembly and nuget versioning is managed through
* The assembly and NuGet versioning is managed through
[MinVer](https://github.com/adamralph/minver) for all the projects in the
repo. MinVer will assign the version to your project based on the tag prefix
specified by you. To ensure your project is versioned appropriately, specify a
Expand Down Expand Up @@ -298,12 +304,13 @@ shipped through CI.

* Add your component name to the [issue
templates](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/.github/ISSUE_TEMPLATE/)
in your PR. The maintainer will help to create a new ["comp:"
label](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/labels?q=comp%3A)
and [.github/security-insights.yml](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/security-insights.yml)
files in your PR. The maintainer will help to create a new
Comment thread
martincostello marked this conversation as resolved.
["comp:" label](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/labels?q=comp%3A)
once the PR is merged.

* Add a `README.md` file for your project describing how to install and use your
package. Every project's README file needs to have a link to the Nuget
package. Every project's README file needs to have a link to the NuGet
package. You can use the below snippet for reference:

```md
Expand Down
Loading