Skip to content

Commit

Permalink
mention that readme shouldn't repeat go docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dmathieu committed Mar 25, 2024
1 parent 60c5d5f commit acdb121
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,9 @@ For a deeper discussion, see

## Documentation

Each (non-internal, non-test) package must be documented using [Go Doc
Comments](https://go.dev/doc/comment), preferably in a `doc.go` file, and have
a `README.md` file containing at least a title and a `pkg.go.dev` badge.
Each (non-internal, non-test) package must be documented using
[Go Doc Comments](https://go.dev/doc/comment),
preferably in a `doc.go` file.

Prefer using [Examples](https://pkg.go.dev/testing#hdr-Examples)
instead of putting code snippets in Go doc comments.
Expand All @@ -201,6 +201,13 @@ You can install and run a "local Go Doc site" in the following way:
[`go.opentelemetry.io/otel/metric`](https://pkg.go.dev/go.opentelemetry.io/otel/metric)
is an example of a very well-documented package.

### README files

Each (non-internal, non-test, non-documentation) module must contain a
`README.md` file containing at least a title, and a `pkg.go.dev` badge.

The README should not be a repetition of Go doc comments.

## Style Guide

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

0 comments on commit acdb121

Please sign in to comment.