Skip to content

Commit a9010df

Browse files
committed
chore: Add contributing guidelines
It's helpful for us Coders to align on a common set of style guidelines. While I'd prefer to automate this, documentation should get us a lot of the way there! Please review these thoroughly, as PRs will be checked against it after merge.
1 parent 3153618 commit a9010df

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
## Style
4+
5+
Contributions must adhere to [Effective Go](https://go.dev/doc/effective_go). Additional styles should prefer automated checks over documentation; humans are error prone!
6+
7+
### No Unused Packages
8+
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.
10+
11+
## Review
12+
13+
> Taken from [Go's review philosophy](https://go.dev/doc/contribute#reviews).
14+
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.
16+
17+
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.
18+
19+
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.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ $ coder projects update gcp-linux
6464

6565
## Development
6666

67-
The code structure is inspired by [Basics of Unix Philosophy](https://homepage.cs.uri.edu/~thenry/resources/unix_art/ch01s06.html) and [Effective Go](https://go.dev/doc/effective_go).
67+
Read the [contributing docs](./CONTRIBUTING.md) for style and review guidelines.
6868

6969
Coder requires Go 1.18+, Node 14+, and GNU Make.
7070

0 commit comments

Comments
 (0)