기여

Ormar에 대한 모든 기부를 환영합니다!

질문

당사가 귀하를 최대한 쉽게 지원할 수 있도록 다음을 포함하십시오.

• 운영 체제
• 파이썬 버전
• 오르마 버전
• 데이터베이스 백엔드(MySQL, SQLite 또는 PostgreSQL)

Ormar를 설치할 수 없거나 문제 또는 기능 요청과 관련이 없다는 것을 알지 못하는 경우 항상 위의 내용을 포함하십시오.

요청 요청

시작 및 꺼내기 요청을 만드는 것은 매우 간단해야 합니다.

!!!변경 사항이 경미하지 않은 경우(철자 오류, 문서 조정 등) 풀 요청을 작성하기 전에 변경 사항에 대해 논의할 질문을 만드십시오.

최대한 간단하고 빠르게 기여하려면 현지에서 테스트와 린치를 실행해야 합니다.

파이썬 3.6.2, 3.7 또는 3.8, 시와 깃을 설치해야 합니다.

#1. 포크와 CD를 repo 디렉토리에 복제합니다.
Git 클론git@github.com:<your username>/ormar.git
CD ormar

#2. ormars, 종속성 및 테스트 종속성 설치
시 설치-E dev

#3. 새 지점을 확인하고 변경
Git 체크 아웃-bmy-new-feature-branch
# 변경하십시오. ..

#4. 포맷과 린팅
# ormar는 포맷을 위해 검은색을 사용하고, 라이팅을 위해 flake8을 사용하고, 타입 힌트 확인을 위해 mypy를 사용합니다.
# 모든 통화는 모든 푸시 후 트래비스에서 실행되므로 다음을 모두 실행합니다.
블랙 오마 테스트
플레이크8 오마르
Mypy ormar 테스트

#5.Run테스트
# localhost 모든 테스트는 sglite 백엔드에 대해 실행됩니다.
# 나머지 백엔드는 푸시 후 확인됩니다.
파이테스트-svv --cov = ormar --cov = 테스트--cov-fail-under=100--cov-report=term-missing

#6.Build문서
MKDOCS 빌딩
# 문서를 변경한 경우 문서가 성공적으로 구축되었는지 확인하십시오.
#`mkdocs serve` 를 사용하여 localhost:8000 문서를 제공할 수도 있습니다.

#. .. 풀 요청을 커밋, 푸시 및 생성

!!!팁 ormar가 작동하는 방법과 이유에 대한 자세한 내용은 API 설명서를 참조하십시오.