-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'Rapiders:main' into main
- Loading branch information
Showing
3 changed files
with
125 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# React-hooks Contributing 가이드 | ||
|
||
커뮤니티의 모든 분들의 Contribution을 환영합니다. | ||
[영어](https://github.com/Rapiders/react-hooks/tree/main/.github/CONTRIBUTING.md)와 한국어 중 편한 언어를 사용하면 됩니다. | ||
|
||
## Fork | ||
|
||
1. 기여하고 싶은 경우 우선 이 레포지토리를 fork 합니다. | ||
2. 작업이 완료되었다면 main 브랜치로 PR을 오픈합니다. | ||
3. merge 되기 위해서는 반드시 maintainer 중 한 명이 이상의 approve를 받아야 합니다. | ||
|
||
## 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 | ||
|
||
### feature | ||
|
||
#### 시작하기 | ||
|
||
feature 이슈를 생성한 후, 원한다면 해당 이슈를 할당받을 수 있습니다. | ||
|
||
작업을 완료한 경우, `index.tsx`에 추가하고 싶은 훅(기능)의 구현체를 export해주세요. | ||
|
||
### Storybook & Docs & Test | ||
|
||
기능을 추가하는 경우 `Storybook 컴포넌트`, `README 문서`, 그리고 `테스트 코드`를 포함해야 합니다. 추가하고 싶지 않은 경우, 반드시 Issue의 feature 섹션에 남은 할 일을 남겨주세요. | ||
|
||
Storybook 컴포넌트를 작성할 때, CSS는 vanilla-extract를 사용합니다. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# 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) | ||
|
||
## Fork | ||
|
||
1. If you wish to contribute, first fork this repository. | ||
2. Once your work is complete, open a PR to the main branch. | ||
3. To be merged, it must receive at least one approval from a maintainer. | ||
|
||
## 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters