기여 가이드¶
OpsMini에 관심을 갖고 기여해 주셔서 감사합니다!
참여 방법¶
- 버그 신고: GitHub Issues에 제출하며 재현 단계, 환경 정보, 로그를 첨부합니다
- 기능 제안: Issues에 사용 시나리오와 기대 사항을 기술합니다
- 코드 제출: 저장소 Fork → 새 브랜치 생성 → 커밋 → Pull Request 생성
- 문서 개선: 문서 오류 수정, 사용 예시 보완
커밋 규칙¶
- 하나의 PR은 하나의 변경에 집중하며, 크고 포괄적인 변경을 피합니다
- Go 공식 코드 스타일 준수(
gofmt/go vet) - 새 기능에는 테스트 케이스 보완
- 커밋 메시지는「무엇을 했는지」「왜 했는지」를 명확히 기술
디렉터리 규약¶
- 계층:
api/v1(Controller)→service(비즈니스)→repository(데이터) - 민감 필드(키 / Token)는 암호화하여 저장
- 새 인터페이스는 통일된 응답
{ code, message, data }를 따릅니다
라이선스¶
프로젝트는 Apache License 2.0을 채택하며, 코드 기여는 해당 라이선스에 따라 라이선스 부여에 동의한 것으로 간주합니다.