Bijdragen
Alle bijdragen aan Ormar zijn welkom!
vraag
Om het ons zo gemakkelijk mogelijk te maken om u te helpen, moet u het volgende vermelden:
- Besturingssysteem
- Python versie
- Ormar versie
- Database-backend (MySQL, SQLite of PostgreSQL)
Probeer altijd het bovenstaande op te nemen, tenzij u Ormar niet kunt installeren of weet dat het niet relevant is voor uw probleem of functieverzoek.
aanvraag aanvragen
Aan de slag gaan en een pull-verzoek maken, moet heel eenvoudig zijn.
!!!Wees voorzichtig, tenzij uw wijzigingen klein zijn (spelfouten, documentaanpassingen, enz.), Maak een vraag om de wijzigingen te bespreken voordat u een pull-verzoek maakt.
Om bijdragen zo eenvoudig en snel mogelijk te maken, moet u lokaal tests en linting uitvoeren.
Je moet Python 3.6.2, 3.7 of 3.8, poëzie en git installeren.
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 | # 1. kloon je vork en cd in de repo directory
Git kloon git@github.com:<your username>/ ormar.git
CD ormar
# 2. Installeer ormars, afhankelijkheden en test afhankelijkheden
Poëzie installeren -E dev
# 3. Bekijk een nieuw filiaal en breng uw wijzigingen aan
Git checkout -b my-new-feature-branch
# breng uw wijzigingen aan...
# 4. Formatteren en linten
# ormar gebruikt zwart voor opmaak, flake8 voor linting en mypy voor het controleren van typehints
# voer al het volgende uit omdat al die oproepen na elke push op travis worden uitgevoerd
Zwarte ormar testen
Vlokje8 ormar
Mypy ormar toetsen
#5.Run toetsen
# op localhost worden alle tests uitgevoerd tegen sglite backend
# De rest van de backends wordt gecontroleerd na het duwen
Pytest -svv --cov = ormar --cov = --cov-fail-under=100 --cov-report=term-missing
#6.Build documentatie
MKDOCS gebouw
# als u de documentatie hebt gewijzigd, zorg er dan voor dat deze met succes wordt gebouwd
# u kunt ook `mkdocs serve` gebruiken om de documentatie bij localhost:8000
#... uw pull-verzoek vastleggen, pushen en maken
|