-
Notifications
You must be signed in to change notification settings - Fork 4
docs: CONTRIBUTING 문서작성 #21
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.
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# React-hooks Contributing 가이드 | ||
|
||
커뮤니티의 모든 분들의 Contribution을 환영합니다. | ||
[영어](https://github.com/Rapiders/react-hooks/tree/main/.github/CONTRIBUTING.md)와 한국어 중 편한 언어를 사용하면 됩니다. | ||
|
||
## Issue | ||
|
||
라이브러리에 기여하는 방법: | ||
|
||
1. 문서 개선하기 (README.md 또는 Storybook) | ||
2. 이슈 탭에 버그 신고하기 | ||
3. 새로운 기능이나 패키지 요청하기(테스트코드 추가하기) | ||
4. 이슈의 todo 목록에서 할당받기 | ||
|
||
## Pull Request | ||
|
||
### Commit Convention | ||
|
||
``` | ||
<type> : <description> | ||
|
||
(body) | ||
|
||
(#issue number) | ||
``` | ||
|
||
괄호부분은 생략될 수 있습니다. | ||
|
||
배포된 코드를 변경하는 경우 | ||
|
||
- feat | ||
- fix | ||
- refactor | ||
|
||
배포된 코드를 변경하지 않는 경우 | ||
|
||
- docs (Storybook 이나 README) | ||
- test | ||
|
||
기타 | ||
|
||
- chore | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 오타 수정과 같이 코드의 변경은 있지만 주요 흐름의 변화가 아닌 경우는 어디에 들어가야 하는지 명시하는 것도 좋을 것 같아요. (ex. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 이외 모든 변경을 chore로 지정하고, 코드의 변경이 있지만, 유의하지 않은경우에는 refactor를 사용하는게 어떨까 싶습니다! |
||
|
||
### feature | ||
|
||
#### 시작하기 | ||
|
||
feature 이슈를 생성한 후, 원한다면 해당 이슈를 할당받을 수 있습니다. | ||
|
||
작업을 완료한 경우, `index.tsx`에 추가하고 싶은 훅(기능)의 구현체를 export해주세요. | ||
|
||
### Storybook & Docs & Test | ||
|
||
기능을 추가하는 경우 `Storybook 컴포넌트`, `README 문서`, 그리고 `테스트 코드`를 포함해야 합니다. 추가하고 싶지 않은 경우, 반드시 Issue의 feature 섹션에 남은 할 일을 남겨주세요. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 테스트 코드의 경우 커버리지 관련 내용이 들어가면 좋을 것 같아요. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 커버리지 기준을 얼마로 하는게 좋을까요? |
||
|
||
Storybook 컴포넌트를 작성할 때, CSS는 vanilla-extract를 사용합니다. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Contributing to React-hooks | ||
|
||
We welcome contribution from everyone in the community. | ||
you can use English and [Korean](https://github.com/Rapiders/react-hooks/tree/main/.github/CONTRIBUTING.ko.md) | ||
|
||
## Issue | ||
|
||
You can contribute to library via: | ||
|
||
1. Improving our docs (README.md or Storybook) | ||
2. Reporting a bug in our issues tab | ||
3. Requesting a new feature or package (adding test code) | ||
4. Having a look at our issue list to see what's to be fixed | ||
|
||
## Pull Request | ||
|
||
### Commit Convention | ||
|
||
``` | ||
<type> : <description> | ||
|
||
(body) | ||
|
||
(#issue number) | ||
``` | ||
|
||
The part in parentheses is optional. | ||
|
||
If you change the deployed code | ||
|
||
- feat | ||
- fix | ||
- refactor | ||
|
||
If you do not change the deployed code | ||
|
||
- docs (Storybook or README) | ||
- test | ||
|
||
ETC | ||
|
||
- chore | ||
|
||
### feature | ||
|
||
#### How to start | ||
|
||
When requesting a feature, you can create an issue and then be assigned to that issue. | ||
|
||
If you have completed your work, please export the implementation of the feature you want to add in `index.tsx`. | ||
|
||
#### Storybook & Docs & Test | ||
|
||
When adding a feature, you must include `Storybook components`, `update README.md`, and `test code`. If you prefer not to add them, please leave a task in the Issue's feature section. | ||
|
||
When writing Storybook components, use vanilla-extract for CSS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
관련 예시도 아래와 같이 추가하면 좋을 것 같아요.
예시)