Skip to content

Commit

Permalink
Update docs/contributing/contributing-code/contributing-code-writing/…
Browse files Browse the repository at this point in the history
…README.md

Co-authored-by: Yetkin Timocin <[email protected]>
  • Loading branch information
rynowak and ytimocin committed Jun 2, 2023
1 parent 629cbeb commit b5572c1
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ We also *mostly* agree with [Google's Go Style Guide](https://google.github.io/s

One thing we do require is [godoc comments](https://tip.golang.org/doc/comment) on **exported** packages, types, variables, constants, and functions. We like this because it has two good effects:

- Encourages you to be minimize the exported surface-area, thus simplifying the design.
- Encourages you to minimize the exported surface-area, thus simplifying the design.
- Requires you to document clearly the purpose code you expect other parts of the codebase to call.

Right now we don't have automated enforcement of this rule, so expect it to come up in code review if you forget.
Expand Down

0 comments on commit b5572c1

Please sign in to comment.