기여 방법 - Notipy-DiscordBot/Notipy GitHub Wiki

🤝 기여 방법

Notipy는 오픈소스 프로젝트이며, 누구나 자유롭게 참여하고 기여할 수 있습니다.
버그 수정, 기능 제안, 문서 개선 등 어떤 방식이든 환영합니다!

✅ 기여 전 준비 사항

  1. GitHub 계정이 있어야 합니다.

  2. 프로젝트를 포크(Fork)하여 본인 저장소로 복제합니다:

    git clone https://github.com/NotiPy-DiscordBot/NotiPy.git

  3. 새로운 기능이나 수정은 별도의 브랜치에서 작업해주세요:

    git checkout -b feature/my-new-feature

🔧 PR 작성 규칙

  • PR 제목 형식

    • [기능] 프로젝트 생성 기능 개선
    • [버그] 알림 중복 전송 문제 해결

  • PR 설명 내용

    • 변경한 이유 및 배경
    • 어떤 파일/기능을 수정했는지
    • 관련된 이슈 번호 (Closes #23 등)

  • 기여 대상 브랜치

    • PR은 항상 dev/main 브랜치로 보내주세요.
    • master는 배포 전용 브랜치입니다.
    • dev/main브랜치에서 테스트봇을 활용하여 개발 서버에서 각종 버그들을 수정하게 됩니다.

🧹 코드 스타일 & 자동 검사

  • 코드는 black 포매터 기준으로 자동 정렬됩니다.
  • PR 생성 시 GitHub Actions가 자동으로 스타일을 검사합니다.
  • 포맷 오류가 발생하면 PR이 거절될 수 있습니다.

🧩 기여 가능한 항목 예시

  • 🐛 버그 수정
  • 🧠 명령어 개선 또는 추가
  • 🌐 다국어 리소스 번역
  • 📝 문서 또는 Wiki 개선
  • 🔒 보안 설정 개선 제안
  • 🧪 테스트 시나리오 제안

🙋 질문 또는 제안은 어디로?

  • 디스코드 지원 서버: 바로가기
  • GitHub Issues 탭을 통해 기능 제안, 버그 신고 모두 가능합니다.

🎉 여러분의 기여가 Notipy를 더 나은 도구로 만듭니다. 작은 수정이라도 감사히 반영하겠습니다!