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

Improve contributor guide #687

Closed
wants to merge 4 commits into from
Closed

Improve contributor guide #687

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f102b1
Update CONTRIBUTING.md
RichardChukwu Feb 11, 2025
ec9ed24
Merge branch 'open-telemetry:main' into main
RichardChukwu Feb 11, 2025
f32c188
Update CONTRIBUTING.md
RichardChukwu Feb 11, 2025
8319a24
Update CONTRIBUTING.md
RichardChukwu Feb 11, 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
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Contributing to opentelemetry-go-build-tools

This repo contains Build tools for use by the Go API/SDK, the collector, and their associated contrib repositories.

New contributors are welcome!

## Pre-requisites
* Go (version required) TBD
Copy link
Member

Choose a reason for hiding this comment

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

I think it is obvious 😉

Copy link
Author

Choose a reason for hiding this comment

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

Not sure it is stated anywhere in the repo though, if its the latest version, I think it would be helpful to include it, as some versions may cause conflicts especially for first time contributors

Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/open-telemetry/opentelemetry-go-build-tools/blob/main/go.mod

Copy link
Author

Choose a reason for hiding this comment

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

ooh, didn't see this, I think it will be useful to add this info to the contributing guide or at least link to this file?

* Any version requirements or compatibility notes TBD
* Mention additional platform-specific notes (e.g., macOS, Windows, Linux differences). TBD


## Development

You can view and edit the source code by cloning this repository:
Expand Down
Loading