Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit61ffd03

Browse files
authored
docs: update contribution guidelines (#1691)
* docs(contributing): add subheading backend under styling* docs: add styling for frontend
1 parentb0d5203 commit61ffd03

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

‎docs/CONTRIBUTING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
#Contributing
32

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

1716
##Styling
1817

19-
###Use Go style
18+
###Backend
19+
20+
####Use Go style
2021

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

29-
###Avoid unused packages
30+
####Avoid unused packages
3031

3132
Coder writes packages that are used during implementation. It isn't easy to
3233
validate whether an abstraction is valid until it's checked against an
3334
implementation. This results in a larger changeset, but it provides reviewers
3435
with a holistic perspective regarding the contribution.
3536

37+
###Frontend
38+
39+
####Follow component conventions
40+
41+
Each component gets its own folder. Make sure you add a test and Storybook
42+
stories for the component as well. By keeping these tidy, the codebase will
43+
remain easy-to-navigate, healthy and maintainable for all contributors.
44+
45+
####Keep accessibility in mind
46+
47+
We strive to keep our UI accessible. When using colors, avoid adding new
48+
elements with low color contrast. Always use labels on inputs, not just
49+
placeholders. These are important for screen-readers.
50+
3651
##Reviews
3752

3853
>The following information has been borrowed from[Go's review

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp