CONTRIBUTING.md

기여하기

이 프로젝트에 관심을 가져주셔서 감사합니다. 여러분의 기여는 프로젝트를 더욱 풍부하고 완성도 높게 만들어줍니다.

기여 방법

1. 이슈 찾기 및 등록하기

   • 프로젝트에 기여하기 전에 먼저 이슈 트래커를 확인하세요.
   • 기여하고자 하는 내용에 대한 이슈가 이미 존재하지 않는다면, 새로운 이슈를 등록하여 의견을 나눠주세요.
   • 이슈를 등록할 때는 문제를 명확하게 설명하고, 필요한 경우 스크린샷이나 추가 자료를 첨부하는 것이 좋습니다.

2. 포크 및 브랜치 생성

   • 프로젝트를 포크(fork)한 뒤, 로컬 환경에 클론(clone)하세요.
   • 적절한 브랜치 이름으로 새 브랜치를 만들어 작업을 시작하세요. 브랜치 이름은 작업 내용을 직관적으로 나타낼 수 있도록 합니다.

3. 변경 사항 커밋

   • 작업 내용에 대한 충분한 단위의 커밋을 만들어주세요. 각 커밋은 명확한 메시지를 포함해야 합니다.
   • 커밋 메시지는 변경 내용을 간결하게 설명해야 하며, 이슈 번호를 포함시킬 수 있습니다 (예: #123).

4. 풀 리퀘스트 생성

   • 로컬에서 작업이 완료되면, GitHub을 통해 풀 리퀘스트(Pull Request)를 생성하세요.
   • 풀 리퀘스트는 main 브랜치로 요청해야 하며, 상세하고 명확한 설명을 포함해야 합니다.
   • 가능하다면 변경 사항의 배경, 목적, 효과 등을 설명하여 리뷰어가 이해하기 쉽도록 도와주세요.

5. 코드 리뷰

   • 다른 개발자들이 제출한 풀 리퀘스트에 대한 리뷰에 참여할 수도 있습니다.
   • 코드 리뷰는 건설적이고 존중하는 태도로 진행해야 합니다.

코드 스타일 및 가이드라인

• 이 프로젝트는 Java와 Spring Boot를 사용하므로, 자바 코딩 규약을 따라주세요.
• 또한, HTML/CSS/JS 등의 프론트엔드 코드도 프로젝트의 일관된 스타일을 유지해야 합니다.
• Google Java Style Guide를 참고하여 코드를 작성하세요.

질문이나 도움이 필요하신가요?

기여 과정에서 질문이나 도움이 필요하다면, 해당 이슈 트래커를 통해 질문을 남겨주세요.

다시 한 번 프로젝트에 관심을 가져주셔서 감사합니다. 여러분의 참여를 기다리고 있습니다!