docs: CONTRIBUTING 문서작성 #21
Merged
Conversation
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
HBSPS
approved these changes
May 27, 2024
|
|
||
| ### Storybook & Docs & Test | ||
|
|
||
| 기능을 추가하는 경우 `Storybook 컴포넌트`, `README 문서`, 그리고 `테스트 코드`를 포함해야 합니다. 추가하고 싶지 않은 경우, 반드시 Issue의 feature 섹션에 남은 할 일을 남겨주세요. |
There was a problem hiding this comment.
테스트 코드의 경우 커버리지 관련 내용이 들어가면 좋을 것 같아요.
Comment on lines
+20
to
+24
| <type> : <description> | ||
|
|
||
| (body) | ||
|
|
||
| (#issue number) |
There was a problem hiding this comment.
관련 예시도 아래와 같이 추가하면 좋을 것 같아요.
예시)
feat: useCustomHook 추가
useCustomHook 구현 부분 추가
#이슈번호
test: useCustomHook 테스트 코드 추가
관련 메소드
- customMethod1
- customMethod2
#이슈번호
|
|
||
| 기타 | ||
|
|
||
| - chore |
There was a problem hiding this comment.
오타 수정과 같이 코드의 변경은 있지만 주요 흐름의 변화가 아닌 경우는 어디에 들어가야 하는지 명시하는 것도 좋을 것 같아요. (ex. chore)
There was a problem hiding this comment.
이외 모든 변경을 chore로 지정하고, 코드의 변경이 있지만, 유의하지 않은경우에는 refactor를 사용하는게 어떨까 싶습니다!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution을 위한 가이드 문서를 작성하였습니다.