From 98f8a463e0b67a9ef8943eaf3564c9271695f12c Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 23 May 2022 21:05:13 +0000 Subject: [PATCH 1/3] docs(contributing): add subheading backend under styling --- docs/CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4164727df51fb..5e52a8f5ca510 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,4 +1,3 @@ - # Contributing ## Requirements @@ -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 @@ -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 From f03efdf8998b2bdc0d583e4e78b167516b928757 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 23 May 2022 21:40:14 +0000 Subject: [PATCH 2/3] docs: add styling for frontend --- docs/CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5e52a8f5ca510..5788995570290 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -34,6 +34,20 @@ validate whether an abstraction is valid until it's checked against an implementation. This results in a larger changeset, but it provides reviewers with a holistic perspective regarding the contribution. +### Frontend + +#### Follow component conventions + +Each component gets it's own folder. Make sure you add a test and Storybook +stories for the component as well. By keeping these tidy, the codebase will +remain easy-to-navigate, healthy and maintainable for all contributors. + +#### Keep accessibility in mind + +We strive to keep our UI accessible. When using colors, avoid adding new +elements with low color contrast. Always use labels on inputs, not just +placeholders. These are important for screen-readers. + ## Reviews > The following information has been borrowed from [Go's review From 69397f0d2b13c019d86e5f67e1c21724c202dbef Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 23 May 2022 14:52:33 -0700 Subject: [PATCH 3/3] Update docs/CONTRIBUTING.md Co-authored-by: Presley Pizzo <1290996+presleyp@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5788995570290..c9abc3d0d1e9d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -38,7 +38,7 @@ with a holistic perspective regarding the contribution. #### Follow component conventions -Each component gets it's own folder. Make sure you add a test and Storybook +Each component gets its own folder. Make sure you add a test and Storybook stories for the component as well. By keeping these tidy, the codebase will remain easy-to-navigate, healthy and maintainable for all contributors.