ISSUE 템플릿에 관해 피드백 부탁드립니다.

[tqx7514]

기능 요청사항 이슈 템플릿

✨ 어떤 기능인가요?

추가하려는 기능에 대해 간결하고 명확하게 설명해 주세요.

📌 왜 필요한 기능인가요?

이 기능이 왜 필요한지, 어떤 문제를 해결할 수 있는지 설명해 주세요.

🛠 작업 상세 내용

• 할 일 1
• 할 일 2
• 할 일 3

🎯 기대 효과

이 기능이 추가되면 어떤 효과가 있을지 작성해 주세요. (예: UX 개선, 개발 생산성 향상 등)

🔗 참고할만한 자료 (선택)

관련 문서, 링크 등을 첨부해 주세요.

---

버그 이슈 템플릿

🐞 버그 설명

발견한 버그에 대해 간결하고 명확하게 설명해 주세요.

🔁 재현 방법 (버그 발생 과정)

1. 어떤 화면에서
2. 어떤 동작을 했을 때
3. 어떤 문제가 발생했는지 단계별로 설명해 주세요.

📷 예상 결과 vs 실제 결과

• 예상 결과: 정상 동작 시 기대했던 결과
• 실제 결과: 버그 발생 시 나타나는 문제

🖥 환경 정보

• 운영체제(OS): (예: Windows 10, macOS Ventura)
• 브라우저 & 버전: (예: Chrome 119, Edge 120)
• 기타 (선택): (예: API 버전, 프레임워크 버전 등)

📎 참고 자료 (선택)

관련 로그, 콘솔 오류 메시지, 스크린샷 등을 첨부해 주세요.

---

혹시 추가됐으면 하는 이슈 템플릿이 있을지 혹은 내용에 들어가거나 빠져야 하는 부분이 있는지 말씀해 주시면 좋을 것 같습니다.

백엔드의 경우 labes를 좀 더 자세히 하며 issues 템플릿을 간소화하여 작성한 것 같다는 생각이 들었습니다.

자유롭게 말씀해 주시면 감사드리겠습니다. 혹은 이대로 좋다고 생각하시면 의견 확인을 위해 하트 부탁드립니다.

[choi1five]

이슈 템플릿 초안 작성하시느라 고생 많으셨습니다! 👍

아이콘으로 제목 구분과 버그 템플릿의 환경 정보가 특히 좋아보이네요.

기능 요청사항 템플릿 중 "어떤 기능인가요?", "왜 필요한가요?", "기대효과" 섹션은 내용이 비슷해서 작성할 때 어느 섹션에 넣어야 할지 헷갈리는 부분이 있을 것 같아요.

예를 들어 "포스트 생성 기능"을 작성할 때

• 어떤 기능? → "사용자가 포스트를 작성하고 발행하는 기능"
• 왜 필요한가? → "사용자들이 자신의 콘텐츠를 공유할 수 있도록"
• 기대효과? → "플랫폼 내 콘텐츠 증가와 사용자 참여도 향상"

실질적으로는 어떤 기능인지에 대한 설명이 주가 될 것 같고, 필요성과 기대효과는 선택적으로 같은 섹션에서 서술해도 좋을 것 같아 하나의 섹션으로 합치는 건 어떠실까요?

[tqx7514]

의견 감사합니다.
어떤 기능인가요?는 남겨두며 필요성과 기대 효과를 하나의 섹션으로 합쳐 기대 효과만 남겨두는게 괜찮을 것 같으니 그렇게 진행해보도록 하겠습니다.

[merge-simpson]

💊 어디까지 포함할지 논의

잘 쓴 이슈 예시로 좋은 템플릿 같습니다!

특히 일부는 이제 곧 합류하실 수도 있는 기획자분들의 성과를 이슈로 조금씩 공개하기에 적합해 보이는데요. 🤔

@choi1five 님 말씀대로 기능 설명을 한 섹션으로 합쳐도, 기능적인 소개가 충분히 매력 있게 담길 수 있을 것 같습니다.

덧붙여서 이런 논의가 필요해 보여요.

• 모든 섹션을 의무화할 것인지
• 일부 섹션만 남길 것인지 (필요하다면 주석이나 설명으로 가이드)
• 모든 섹션을 남기되, 대부분 섹션을 작성자가 알아서 지우도록 선택 사항으로 할지 등

모든 섹션을 의무화하기에 혹시나 작성에 허들이 생길 것 같다면 이런 검토를 해야 할 것 같습니다.

다들 의견을 모아 주세요!

[tqx7514]

감사합니다. 우선 필요성과 기대 효과 섹션을 합친 후 논의해보겠습니다.

[Seono-Na]

@tqx7514 님 이슈 템플릿 잘 만들어주고 계시네요!.
특히 버그 템플릿을 따로 분리해주신 점이 좋아보여요.

전 일부 섹션만 남기고 필요하다면 주석이나 부연 설명으로 가이드하는게 좋아보입니다.

작성해주신 부분에서 예를 들자면,
어떤 기능인지, 왜 필요한지, 기대효과 같이 기능에 대한 설명에 포함 시킬 수 있는 부분을
한 섹션으로 묶고 그 부븐을 부연 설명으로 남겨 두는 게 어떨까 합니다.

그렇게 하면 작성자에게 자유도를 줄 수 있고,
이슈 작성 허들을 낮춰줄 수도 있어서 좋지 않을까 생각합니다!

[tqx7514]

의견 감사합니다! 말씀해주신대로 그렇게 제작하여 등록해보았으니 확인해주시면 감사드리겠습니다