Contribution

Toutes les contributions à Ormar sont les bienvenues!

Problème avec

Pour que nous puissions vous aider le plus simplement possible, veuillez inclure les éléments suivants:

• système d'exploitation
• Version de Python
• Version d'Ormar
• Backend de base de données (mysql, sqlite ou postgresql)

Essayez de toujours inclure ce qui précède, sauf si vous ne pouvez pas installer ormar ou si vous savez que cela n'a rien à voir avec votre problème ou votre demande de fonctionnalité.

Demander une demande

Démarrer et créer une pull request devrait être très simple.

!!!Remarque À moins que vos modifications ne soient insignifiantes (fautes d'orthographe, ajustements de documents, etc.), créez une question pour discuter des modifications avant de créer une pull request.

Pour rendre les contributions aussi simples et rapides que possible, vous devez exécuter des tests et des tests localement.

Vous devez installer python 3.6.2, 3.7 ou 3.8, poetry et git.

# 1. clone votre fork et CD dans le répertoire de repo
git clone git@github.com:<your username>/ormar.git
CD par Ormar

# 2. installer les dépendances, les dépendances et les dépendances de test
poetry install -E dev

# 3. vérifier une nouvelle marque et faire vos changements
git checkout -b my-new-feature-branch
#Faites vos changements…

# 4. formatage et linting
# ormar utilise noir pour formatage, flake8 pour linting et mypy pour vérification des points de type
# run all of the following as all those calls will be run on traves after every push
Black Ormar testés par
Flake8 par Ormar
Mypy Ormar testés

# 5. exécuter des tests
#sur localhost tous les tests sont en cours d'exécution contre le backend sglite
# Rest of the backends sera checké après la poussée
pytest -svv --cov=ormar --cov=tests --cov-fail-under=100 --cov-report=term-missing

#6. documentation de construction
mkdocs construit
#Si vous avez modifié la documentation pour la rendre plus sûre, elle sera construite avec succès.
#Vous pouvez aussi utiliser `mkdocs serve` pour servir la documentation à localhost:8000

# ... commit, push, and create your pull demande

!!!Pour plus d'informations sur comment et pourquoi ormar fonctionne de cette façon, consultez la documentation de l'API