Skip to content

Commit

Permalink
add contributing doc about readmes requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmathieu
dmathieu committed Mar 25, 2024
1 parent 0207916 commit 60c5d5f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
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.
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.

Prefer using [Examples](https://pkg.go.dev/testing#hdr-Examples)
instead of putting code snippets in Go doc comments.
Expand Down

0 comments on commit 60c5d5f

Please sign in to comment.