Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 2.22 KB

File metadata and controls

56 lines (43 loc) · 2.22 KB

Contributing Guide

Thank you for contributing. Please follow the workflow below.

Issue Reporting

  • Report bugs or feature requests through GitHub Issues.
  • Include a clear title, reproduction steps, and related logs.

Branch Policy

  • The main branch contains only stable code.
  • Create new features on a branch named feature/<issue-number> and open a pull request (PR).

Code Style

  • Follow PEP 8 Python style guide.
  • Use type hints for function parameters and return values.
  • Use async/await for asynchronous operations.
  • Keep functions focused and modular (Single Responsibility Principle).

Pull Request Checklist

  • Add or update tests for all affected areas.
  • In your PR description, include the commands you ran and their results.
  • Ensure CI checks pass before requesting review.

Support and Questions

  • Bug reports & suggestions: via GitHub Issues
  • Discussions & Q&A: via GitHub Discussions or the upcoming community channel
  • Security issues: email vowser_security@gmail.com instead of posting publicly.

기여 가이드

기여해 주셔서 감사합니다. 아래 절차를 따라 주세요.

이슈 등록

  • 버그나 기능 요청은 GitHub Issues로 제출합니다.
  • 제목, 재현 절차, 관련 로그를 포함해 주세요.

브랜치 정책

  • main 브랜치는 안정화된 코드만 유지합니다.
  • 새 기능은 feature/<이슈-번호> 브랜치에서 작업 후 Pull Request(PR)를 생성합니다.

코드 스타일

  • PEP 8 Python 스타일 가이드를 따릅니다.
  • 함수 매개변수와 반환값에 타입 힌트를 사용합니다.
  • 비동기 작업에는 async/await를 사용합니다.
  • 함수는 단일 책임 원칙에 따라 간결하게 작성합니다.

PR 체크리스트

  • 변경된 영역의 테스트를 추가하거나 갱신하세요.
  • PR 본문에 실행 명령과 결과를 기록하세요.
  • 리뷰 요청 전 모든 CI 검사를 통과해야 합니다.

지원 및 문의

  • 버그 신고 및 제안: GitHub Issues
  • 논의 및 질의응답: GitHub Discussions 또는 커뮤니티 채널
  • 보안 이슈 제보: vowser_security@gmail.com 으로 비공개 보고