Skip to content

Update README with import instructions and how to build / test #505

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.

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 6 commits into from
Mar 12, 2020

Conversation

MikeGoldsmith
Copy link
Member

Closed #476.

@paivagustavo
Copy link
Member

Hey @MikeGoldsmith, thanks for picking this up!

As I've already stated, I'm -1 on remove the instructions to go get the lib.

It works just fine for the main use case of the OpenTelemetry Go which is adding the lib to a project when using Go modules, which is the recommended dependency management by the Go language team.

Anyway, If others are fine with these changes I'll not try to block it in any way.

README.md Outdated
@@ -19,14 +19,27 @@ Libraries that produce telemetry data should only depend on `api`
and defer the choice of the SDK to the application developer. Applications may
depend on `sdk` or another package that implements the API.

To install the API and SDK packages,
All packages are published to [https://pkg.go.dev/go.opentelemetry.io/otel](https://pkg.go.dev/go.opentelemetry.io/otel) and is the preferred location to import from.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
All packages are published to [https://pkg.go.dev/go.opentelemetry.io/otel](https://pkg.go.dev/go.opentelemetry.io/otel) and is the preferred location to import from.
All packages are published to [go.opentelemetry.io/otel](https://pkg.go.dev/go.opentelemetry.io/otel) and is the preferred location to import from.

My suggestion would also be to add links to https://blog.golang.org/using-go-modules and https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them as pointers about adding a dependency to the project.

README.md Outdated

## Building the code
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 that this basically duplicates what's written in CONTRIBUTING.md, so instead of having ## Building the code section, I'd move the ## Contributing section from below to here. And then modify the CONTRIBUTING.md file to remove the go get invocation.

Copy link
Member

Choose a reason for hiding this comment

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

+1 for not adding this Building the code since we already have the Contributing and it is harder to maintain two files that have similar content.

@krnowak
Copy link
Member

krnowak commented Mar 3, 2020

Hey @MikeGoldsmith, thanks for picking this up!

As I've already stated, I'm -1 on remove the instructions to go get the lib.

It works just fine for the main use case of the OpenTelemetry Go which is adding the lib to a project when using Go modules, which is the recommended dependency management by the Go language team.

go get is a way to add deps to the project, true. But I don't think that our README.md should be talking about it at all - I suggested adding links to some golang blog post and docs, which is a superior source of information about how to add a dependency. Using go get as a way to get sources to contribute is already considered legacy, so I'm proposing removing it in favor of git clone from CONTRIBUTING.md.

@paivagustavo
Copy link
Member

go get is a way to add deps to the project, true. But I don't think that our README.md should be talking about it at all - I suggested adding links to some golang blog post and docs, which is a superior source of information about how to add a dependency.

In my experience it is very handy to have the go get ... command on the readme, it helps experienced Go programmers to quickly get started with a lib and use it. This is very a very common pattern and I think we should follow it, if you take a look the biggest Go libs almost all of them have this instruction at the top of the README.md.

It is interesting to link docs and blogs about go modules. I would just ask ourselves, what are the expected audience of the Otel Go? I don't think it is someone who is new to Go. I'm not opposing to that but I don't think it also necessary.

Using go get as a way to get sources to contribute is already considered legacy, so I'm proposing removing it in favor of git clone from CONTRIBUTING.md.

Totally agree. I'm in favor of changing the CONTRIBUTING.md but not the README.md

@MikeGoldsmith
Copy link
Member Author

I'll remove building the code section from README and update CONTRIBUTING.md with build instructions.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
MikeGoldsmith Mike Goldsmith
@MikeGoldsmith MikeGoldsmith requested a review from MrAlias as a code owner March 6, 2020 14:32
@MikeGoldsmith MikeGoldsmith requested a review from krnowak March 6, 2020 14:36
@rghetia rghetia merged commit 2ccddfe into open-telemetry:master Mar 12, 2020
MikeGoldsmith added a commit to MikeGoldsmith/opentelemetry-go that referenced this pull request Mar 13, 2020
…telemetry#505)

* update README with import instructions and how to build / test

* fix typo

* remove building the code section from README.md

* add clone instructions to CONTRIBUTING.md

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
Co-authored-by: Rahul Patel <rahulpa@google.com>
@pellared pellared added this to the untracked milestone Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README.md
7 participants