Skip to content

docs: update contribution guidelines #1691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 24, 2022
Merged

docs: update contribution guidelines #1691

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98f8a46
docs(contributing): add subheading backend under styling
jsjoeio May 23, 2022
f03efdf
docs: add styling for frontend
jsjoeio May 23, 2022
69397f0
Update docs/CONTRIBUTING.md
jsjoeio May 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(contributing): add subheading backend under styling
  • Loading branch information
@jsjoeio
jsjoeio committed May 24, 2022
commit 98f8a463e0b67a9ef8943eaf3564c9271695f12c
7 changes: 4 additions & 3 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributing

## Requirements
Expand All @@ -16,7 +15,9 @@ Use the following `make` commands and scripts in development:

## Styling

### Use Go style
### Backend

#### Use Go style

Contributions must adhere to the guidelines outlined in [Effective
Go](https://go.dev/doc/effective_go). We prefer linting rules over documenting
Expand All @@ -26,7 +27,7 @@ Read [Go's Code Review Comments
Wiki](https://github.com/golang/go/wiki/CodeReviewComments) for information on
common comments made during reviews of Go code.

### Avoid unused packages
#### Avoid unused packages

Coder writes packages that are used during implementation. It isn't easy to
validate whether an abstraction is valid until it's checked against an
Expand Down