Skip to content
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] Pull Request template 작성 #3

Merged
merged 4 commits into from
Nov 12, 2024
Merged

[Docs] Pull Request template 작성 #3

merged 4 commits into from
Nov 12, 2024

Conversation

eyeol
Copy link
Contributor

@eyeol eyeol commented Nov 11, 2024

📝 Summary

체계적인 프로젝트 진행을 위한 PR 템플릿을 만들었습니다.

image

📄 How to Use

image

해당하는 부분에 x 표시를 해줍니다.

x 작성 시 대괄호 내에 공백이 없어야 합니다.


image

자세한 PR 내역을 설명하고, 필요에 따라 주의점(Notice)을 선택적으로 작성하시면 됩니다.

해당 PR이 프로젝트에 얼마 정도의 임팩트를 줄지도 (가벼운 마음으로)체크해주세요.

image

PR에서는 close {issue number}로 특정 이슈를 close할 수 있습니다.
close할 이슈가 없다면, {issue number}만 남기셔도 좋습니다.

💡 Notice

해당 PR 템플릿은 말 그대로 템플릿일 뿐, 각자가 원하는 형식으로 PR을 작성하셔도 좋습니다.

@eyeol eyeol self-assigned this Nov 11, 2024
@eyeol eyeol changed the title [docs] Pull Request 템플릿 작성 [Docs] Pull Request 템플릿 작성 Nov 11, 2024
@eyeol eyeol changed the title [Docs] Pull Request 템플릿 작성 [Docs] Pull Request template 작성 Nov 11, 2024
@Usunwoo
Copy link
Contributor

Usunwoo commented Nov 11, 2024

너무 좋아요!! 고생하셨습니당

@chell9999
Copy link
Contributor

수고하셨습니다!

@gsgh3016
Copy link
Contributor

고생 많으셨어요 :)

Copy link
Contributor

@jagaldol jagaldol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

시범적으로 #4 에서 해당 PR 템플릿을 활용해보았는데 구성이 이뻐서 맘에 들었습니다!

근데 체크박스의 존재로 인해 4/7 task 완료 이렇게 뜨더라고요

image

차라리 체크박스 비워두지 않고 취소선 긋는건 어떨까요?

image

밑에 Impact 쪽은 이렇게 해당하는 것만 남기고 지웠습니다.

image


혹은 Priority 같은 건 labels를 활용해도 좋을 거 같은데 어떤가요?

@jagaldol
Copy link
Contributor

@eyeol priority labels 추가해서 #4 에 적용해보았는데 보고 평가 좀 해주세요

@eyeol
Copy link
Contributor Author

eyeol commented Nov 12, 2024

@eyeol priority labels 추가해서 #4 에 적용해보았는데 보고 평가 좀 해주세요

앞서 말씀해주신 취소선 부분을 주석에 부연 설명으로 추가했고
Impact 부분은 삭제했습니다.

priorty labels 부분에 대해서는 레퍼런스로 보내주신 Sane GitHub Labels를 대략적으로 확인해봤는데 말씀해주신 priority labels를 사용하는게 좋을 것 같다고 느꼈습니다.

type도 기회가 되면 이번 프로젝트나 다음 프로젝트에서 시도해봐도 좋을것 같습니다.

Copy link
Contributor

@jagaldol jagaldol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수고하셨습니다!

@eyeol eyeol merged commit 8c24516 into main Nov 12, 2024
3 checks passed
@eyeol eyeol deleted the feature/github-template branch November 12, 2024 04:29
@eyeol eyeol added Priority: Medium 적절한 시기에 처리해야 할 작업 Type: Enhancement 기능 개선 작업 labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium 적절한 시기에 처리해야 할 작업 Type: Enhancement 기능 개선 작업
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants