Skip to content

Commit fbc4ac8

Browse files
committed
Merge branch 'main' into contributing
2 parents a9010df + f02b8fd commit fbc4ac8

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Contributing
22

3-
## Style
3+
## Go Style
44

55
Contributions must adhere to [Effective Go](https://go.dev/doc/effective_go). Additional styles should prefer automated checks over documentation; humans are error prone!
66

7+
Read [Go's Code Review Comments Wiki](https://github.com/golang/go/wiki/CodeReviewComments) to find common comments made during reviews of Go code.
8+
79
### No Unused Packages
810

9-
Coders write packages that are used during implementation. It's difficult to validate whether an abstraction is valid until it's checked against an implementation. This results in a larger changeset, but provides reviewers with an educated perspective on the contribution.
11+
Coders write packages that are used during implementation. It's difficult to validate whether an abstraction is valid until it's checked against an implementation. This results in a larger changeset but provides reviewers with an educated perspective on the contribution.
1012

1113
## Review
1214

1315
> Taken from [Go's review philosophy](https://go.dev/doc/contribute#reviews).
1416
15-
Coders value very thorough reviews. Think of each review comment like a ticket: you are expected to somehow "close" it by acting on it, either by implementing the suggestion or convincing the reviewer otherwise.
17+
Coders value thorough reviews. Think of each review comment like a ticket: you are expected to somehow "close" it by acting on it, either by implementing the suggestion or convincing the reviewer otherwise.
1618

1719
After you update the change, go through the review comments and make sure to reply to every one. You can click the "Done" button to reply indicating that you've implemented the reviewer's suggestion; otherwise, click on "Reply" and explain why you have not, or what you have done instead.
1820

1921
It is perfectly normal for changes to go through several round of reviews, with one or more reviewers making new comments every time and then waiting for an updated change before reviewing again. This cycle happens even for experienced contributors, so don't be discouraged by it.
20-
21-
Read [Go's Code Review Comments Wiki](https://github.com/golang/go/wiki/CodeReviewComments) to find common comments made during reviews of Go code.
File renamed without changes.

0 commit comments

Comments
 (0)