-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
In my experience it is very handy to have the 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.
Totally agree. I'm in favor of changing the |
I'll remove |
…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>
Closed #476.