Beitragend¶

Beiträge sind willkommen, und sie werden sehr geschätzt! Jedes kleine bisschen hilft, und Kredit wird immer gegeben.

Sie können auf viele Arten beitragen:

Arten von Beiträgen¶

Fehler melden¶

Melden Sie Fehler unter https://github.com/SekouD/potranslator/issues.

Wenn Sie einen Fehler melden, geben Sie Folgendes an:

Ihr Betriebssystem Name und Version.
Alle Details zu Ihrer lokalen Konfiguration, die bei der Fehlerbehebung hilfreich sein können.
Detaillierte Schritte zum Reproduzieren des Fehlers.

Fehler beheben¶

Sehen Sie sich die GitHub-Probleme an. Alles, was mit „bug“ und „help wanted“ getaggt ist, steht jedem offen, der es implementieren will.

Funktionen implementieren¶

Sehen Sie sich die GitHub-Ausgaben für Funktionen an. Alles, was mit „Enhancement“ und „help wanted“ gekennzeichnet ist, steht jedem offen, der es implementieren möchte.

Dokumentation schreiben¶

Potranslator könnte immer mehr Dokumentation verwenden, sei es als Teil der offiziellen Potranslator-Dokumentation, in Docstrings oder sogar im Web in Blogposts, Artikeln und so weiter.

Feedback senden¶

Der beste Weg, Feedback zu senden, besteht darin, ein Problem unter https://github.com/SekouD/potranslator/issues zu melden.

Wenn Sie ein Feature vorschlagen:

Erklären Sie im Detail, wie es funktionieren würde.
Halten Sie den Umfang so eng wie möglich, um die Implementierung zu erleichtern.
Denken Sie daran, dass dies ein freiwilliges Projekt ist und dass Beiträge willkommen sind :)

Loslegen!¶

Bereit zum Beitrag? Hier erfahren Sie, wie Sie den „Potranslator“ für die lokale Entwicklung einrichten.

Fork den Potranslator Repo auf GitHub.

Klonen Sie Ihre Gabel lokal:

$ git clone git@github.com:your_name_here/potranslator.git

Installiere deine lokale Kopie in ein virtualenv. Angenommen, Sie haben virtualenvwrapper installiert, so richten Sie Ihren fork für lokale Entwicklung ein:
```
$ mkvirtualenv potranslator
$ cd potranslator/
$ python setup.py develop
```
Erstellen Sie eine Niederlassung für lokale Entwicklung
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Jetzt können Sie Ihre Änderungen lokal vornehmen.
Wenn Sie mit den Änderungen fertig sind, überprüfen Sie, ob Ihre Änderungen flake8 und die Tests bestehen, einschließlich Tests anderer Python-Versionen mit tox
```
$ flake8 potranslator tests
$ python setup.py test or py.test
$ tox
```
Um Flocke8 und Tox zu erhalten, installiere sie einfach in dein virtualenv.

Übernehmen Sie Ihre Änderungen und schieben Sie Ihren Zweig zu GitHub

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Senden Sie eine Pull-Anfrage über die GitHub-Website.

Pull Request Richtlinien¶

Bevor Sie eine Pull-Anforderung senden, überprüfen Sie, ob diese Richtlinien erfüllt sind:

Die Pull-Anforderung sollte Tests enthalten.
Wenn die Pull-Anforderung Funktionalität hinzufügt, sollten die Dokumente aktualisiert werden. Fügen Sie Ihre neue Funktionalität in eine Funktion mit einem Docstring ein und fügen Sie sie der Liste in README.rst hinzu.
Die Pull-Anfrage sollte für Python 2.7, 3.4, 3.5 und 3.6 und für PyPy funktionieren. Überprüfen Sie https://travis-ci.org/SekouD/potranslator/pull_requests und stellen Sie sicher, dass die Tests für alle unterstützten Python-Versionen gelten.

Tipps¶

So führen Sie eine Teilmenge von Tests aus

$ py.test tests.test_potranslator

Bereitstellen¶

Eine Erinnerung für die Betreuer zur Bereitstellung. Stellen Sie sicher, dass alle Ihre Änderungen festgeschrieben sind (einschließlich eines Eintrags in HISTORY.rst). Dann renne:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis wird dann in PyPI bereitstellen, wenn Tests bestanden werden.