File tree 3 files changed +32
-21
lines changed
3 files changed +32
-21
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
3
+ ## Go Style
4
+
5
+ Contributions must adhere to [ Effective Go] ( https://go.dev/doc/effective_go ) . Linting rules should
6
+ be preferred over documenting styles (run ours with ` make lint ` ); humans are error prone!
7
+
8
+ Read [ Go's Code Review Comments Wiki] ( https://github.com/golang/go/wiki/CodeReviewComments ) to find
9
+ common comments made during reviews of Go code.
10
+
11
+ ### No Unused Packages
12
+
13
+ Coders write packages that are used during implementation. It's difficult to validate whether an
14
+ abstraction is valid until it's checked against an implementation. This results in a larger
15
+ changeset but provides reviewers with an educated perspective on the contribution.
16
+
17
+ ## Review
18
+
19
+ > Taken from [ Go's review philosophy] ( https://go.dev/doc/contribute#reviews ) .
20
+
21
+ Coders value thorough reviews. Think of each review comment like a ticket: you are expected to
22
+ somehow "close" it by acting on it, either by implementing the suggestion or convincing the reviewer
23
+ otherwise.
24
+
25
+ After you update the change, go through the review comments and make sure to reply to every one. You
26
+ can click the "Done" button to reply indicating that you've implemented the reviewer's suggestion;
27
+ otherwise, click on "Reply" and explain why you have not, or what you have done instead.
28
+
29
+ It is perfectly normal for changes to go through several round of reviews, with one or more
30
+ reviewers making new comments every time and then waiting for an updated change before reviewing
31
+ again. All contributors, including experienced maintainers, are subject to the same review cycle;
32
+ this process is not meant to be applied selectively or discourage anyone from contribution.
File renamed without changes.
You can’t perform that action at this time.
0 commit comments