Mitwirken
Willkommen bei allen Helfern von Orban !
Die Frage
Damit wir Ihnen so einfach wie möglich helfen können , geben Sie bitte Folgendes an :
- Das Betriebssystem
- Python Versionen
- ORMA Versionen
- Backend für Datenbanken (MySQL , PostgreSQL oder SQLite)
Bitte versuchen Sie immer , die oben genannten Elemente einzubeziehen , es sei denn , Sie können ormar nicht installieren oder wissen , dass es sich nicht um Ihr Problem oder Ihre Funktionsanfrage handelt .
Antrag beantragen
Das Starten und Erstellen von Pull-Requests sollte sehr einfach sein .
!!!Hinweis Sofern Ihre Änderungen nicht trivial sind (Tippfehler , Dokumentänderungen usw .) , erstellen Sie eine Frage , um die Änderungen zu besprechen , bevor Sie eine Pull-Anfrage erstellen .
Um Beiträge so einfach und schnell wie möglich zu machen , müssen Sie Tests und Linting lokal ausführen .
Sie müssen Python 3.6.2 , 3.7 oder 3.8 , Poetry und Git installieren .
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29 | Clone your fork und cd into the repo directory (Klonen Sie Ihre Fork und CD ins Repo Verzeichnis)
mit clonegit@github.com:<your username>/ormar.git oder
CD von Ormar
Install ormar , abhängig und test abhängig .
POETRY INSTALL - E DEV herunterladen
3 . Überprüfen Sie einen neuen Zweig und machen Sie Ihre Änderungen
git checkout - b my-new - feature-branch (engl . für „ my-new - feature-branch ")
Machen Sie Ihre Änderungen ...
4 . Formgebung und Linting
Ormar uses black for formatting , flake8 for linting and mypy for type hints check (Ormar benutzt schwarz für Formatierung , Flake8 für Linting und mypy für Typenhints-Check)
" Laufen Sie alle Ihre folgenden Anrufe auf Reisen nach jedem Push . "
Der Black Ormar Test
Flake8ormar gebraucht
Meine Ormar Tests
#5: Die Testfahrt
#on localhost Alle Tests laufen gegen das sglite Backend
Der Rest der Backends wird nach dem Push ausgecheckt
pytest-svv--cov = ormar--cov = tests--cov-fail-under = 100--cov-report = term-missing
#6 Dokumentation erstellen
MKDocs erstellen
#Wenn Sie die Dokumentation geändert haben, um sicher zu sein, dass es erfolgreich aufgebaut wurde
#Sie können auch `mkdocs serve` verwenden, um die Dokumentation auf localhost zu bedienen: 8000
commit, push und erzeuge deine pull request.
|
!!!Weitere Informationen dazu, wie und warum ormar so funktioniert, finden Sie in der API-Dokumentation.