Skip to content

CONTRIBUTING - update PR with example of new project #2920

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
merged 2 commits into from
Jul 21, 2025
Merged

CONTRIBUTING - update PR with example of new project #2920

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5b291b
CONTRIBUTING - update RR with new example
Kielek Jul 17, 2025
a136c61
Merge branch 'main' into update-contributing
Kielek Jul 21, 2025
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,8 @@ shipped through CI.
> [!NOTE]
> It is generally helpful to reference a previous pull request when adding a new
project to the repository. A good example to follow is the pull request which
added the `OpenTelemetry.Resources.OperatingSystem` project:
[#1943](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1943).
added the `OpenTelemetry.OpAmp.Client` project:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would call that a bad example as the build consumes over 6hrs of build time & runs over 200 actions hence not efficient. I wouldn't want more projects following that example, hence a better example should be selected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is about document current state of the implementation. If you see possibility to improve, we are opened for this.
If changes are touch only one project, only small subset of builds is executed. See: https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/workflows/ci.yml#L25-L74

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i am aware of that massive if etc. If you look at: #2926 you will see what i am seeing as that did a massive run and we are yet to see a case of a non massive run. The only change to a file not in the opamp folder is the removal of a project from the verify-aot step but it still ran a massive long list of actions hence far from efficent. It appears to be simply treating any yaml changes in the github folder as grounds for an entire build, hence lots of room for improvement. I have already put in a PR to adopt modules which detangles responsibility for build process and is all documented.

[#2917](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2917).

* Based on what your project is, you may need to depend on the [OpenTelemetry
SDK](https://www.nuget.org/packages/OpenTelemetry) or the [OpenTelemetry
Expand Down