From 69b108050eb62f20bcbb84486a07d2b09339d3e3 Mon Sep 17 00:00:00 2001 From: csuzhang Date: Fri, 30 Jun 2023 11:52:21 +0800 Subject: [PATCH] feat: fix contributing doc --- CONTRIBUTING.md | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b58156ca..8fa8fec8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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