Skip to content

Commit

Permalink
feat: fix contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hanyuancheung committed Jun 30, 2023
1 parent 6fc9421 commit 69b1080
Showing 1 changed file with 0 additions and 20 deletions.
20 changes: 0 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,26 +96,6 @@ patterns in the spec.
For a deeper discussion, see
[this](/~https://github.com/open-telemetry/opentelemetry-specification/issues/165).

## Documentation

Each non-example Go Module should have its own `README.md` containing:

- A pkg.go.dev badge which can be generated [here](https://pkg.go.dev/badge/).
- Brief description.
- Installation instructions (and requirements if applicable).
- Hyperlink to an example. Depending on the component the example can be:
- An `example_test.go` like [here](exporters/stdout/stdouttrace/example_test.go).
- A sample Go application with its own `README.md`, like [here](example/zipkin).
- Additional documentation sections such us:
- Configuration,
- Contributing,
- References.

[Here](exporters/jaeger/README.md) is an example of a concise `README.md`.

Moreover, it should be possible to navigate to any `README.md` from the
root `README.md`.

## Style Guide

One of the primary goals of this project is that it is actually used by
Expand Down

0 comments on commit 69b1080

Please sign in to comment.