From f8b8c6c26a693c61b3ccf1b4d34c20c48fd03b4e Mon Sep 17 00:00:00 2001 From: d0422 Date: Mon, 27 May 2024 18:04:22 +0900 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20CONTRIBUTING=20=EB=AC=B8=EC=84=9C?= =?UTF-8?q?=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CONTRIBUTING.ko.md | 56 ++++++++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++++++++++++ README.md | 1 + 3 files changed, 113 insertions(+) create mode 100644 .github/CONTRIBUTING.ko.md create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.ko.md b/.github/CONTRIBUTING.ko.md new file mode 100644 index 0000000..c680bd9 --- /dev/null +++ b/.github/CONTRIBUTING.ko.md @@ -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 + +``` + : + +(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를 사용합니다. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..9eb9810 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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 + +``` + : + +(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. diff --git a/README.md b/README.md index a61f677..5e1ea83 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ It is a package that collects hooks that are often used for quick development. [Korean Docs](https://rapiders.github.io/react-hooks/) +[Contribution](https://github.com/Rapiders/react-hooks/tree/main/.github/CONTRIBUTING.md) # Usage From 22f652510671f9937fa4a54ecf5e2667a90c68f5 Mon Sep 17 00:00:00 2001 From: d0422 Date: Tue, 28 May 2024 16:55:10 +0900 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20fork=20=EA=B0=80=EC=9D=B4=EB=93=9C?= =?UTF-8?q?=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CONTRIBUTING.ko.md | 8 +++++++- .github/CONTRIBUTING.md | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.ko.md b/.github/CONTRIBUTING.ko.md index c680bd9..c8f167e 100644 --- a/.github/CONTRIBUTING.ko.md +++ b/.github/CONTRIBUTING.ko.md @@ -3,6 +3,12 @@ 커뮤니티의 모든 분들의 Contribution을 환영합니다. [영어](https://github.com/Rapiders/react-hooks/tree/main/.github/CONTRIBUTING.md)와 한국어 중 편한 언어를 사용하면 됩니다. +## Fork + +1. 기여하고 싶은 경우 우선 이 레포지토리를 fork 합니다. +2. 작업이 완료되었다면 main 브랜치로 PR을 오픈합니다. +3. merge 되기 위해서는 반드시 maintainer 중 한 명이 이상의 approve를 받아야 합니다. + ## Issue 라이브러리에 기여하는 방법: @@ -37,7 +43,7 @@ - docs (Storybook 이나 README) - test -기타 +이외 모든 변경 - chore diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9eb9810..22018e4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,6 +3,12 @@ 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: