-
Notifications
You must be signed in to change notification settings - Fork 3
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
docs: CONTRIBUTING 문서작성 #21
Conversation
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.
전체적인 흐름에 관한 내용도 추가되면 좋을 것 같습니다.
ex)
- 새로운 훅을 만들어 기여하고 싶은 경우 우선 이 레포지토리를 fork 합니다.
- 작업이 완료되었다면
main
브랜치로 PR을 오픈합니다. - merge 되기 위해서는 반드시 maintainer 중 한 명이 이상의 approve를 받아야 합니다. (Reviewer로 지정해주세요)
|
||
### Storybook & Docs & Test | ||
|
||
기능을 추가하는 경우 `Storybook 컴포넌트`, `README 문서`, 그리고 `테스트 코드`를 포함해야 합니다. 추가하고 싶지 않은 경우, 반드시 Issue의 feature 섹션에 남은 할 일을 남겨주세요. |
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.
테스트 코드의 경우 커버리지 관련 내용이 들어가면 좋을 것 같아요.
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.
커버리지 기준을 얼마로 하는게 좋을까요?
<type> : <description> | ||
|
||
(body) | ||
|
||
(#issue number) |
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.
관련 예시도 아래와 같이 추가하면 좋을 것 같아요.
예시)
feat: useCustomHook 추가
useCustomHook 구현 부분 추가
#이슈번호
test: useCustomHook 테스트 코드 추가
관련 메소드
- customMethod1
- customMethod2
#이슈번호
|
||
기타 | ||
|
||
- chore |
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.
오타 수정과 같이 코드의 변경은 있지만 주요 흐름의 변화가 아닌 경우는 어디에 들어가야 하는지 명시하는 것도 좋을 것 같아요. (ex. chore
)
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.
이외 모든 변경을 chore로 지정하고, 코드의 변경이 있지만, 유의하지 않은경우에는 refactor를 사용하는게 어떨까 싶습니다!
Contribution을 위한 가이드 문서를 작성하였습니다.