Bei django Organice mitarbeiten¶

Offizielle Repositories: (synchronisiert)

Bitbucket: https://bitbucket.org/organice/django-organice
GitHub: https://github.com/Organice/django-organice

Forken Sie eines der Repositories, machen Sie Ihre Änderungen oder fügen Sie neuen Code hinzu, und eröffnen Sie einen Pull Request.

Wie fange ich an?¶

Nach dem Klonen Ihres eigenen Forks von Bitbucket oder GitHub stellen Sie sicher, dass Sie ein Virtual Environment für die Entwicklung erstellt und aktiviert haben, dann führen Sie make develop aus, um die Packages zu installieren, die Ihnen bei der Entwicklung helfen (Testwerkzeuge, Übersetzungstools, Dokumentationsgeneratoren).

Richtlinien¶

Der primäre Ziel-Interpreter für die Entwicklung ist Python 3. Am besten verwenden Sie die höchste Versionsnummer, die mit dem in das Projekt integrierten Django package kompatibel ist (momentan 3.4). Alle anderen unterstützten Python-Versionen werden vom integration server getestet, sobald Sie einen Pull Request eröffnen. Sie können Tests mittels tox oder setup.py test lokal ausführen, bevor Sie pushen, z.B.

$ tox               # run all tests against all supported Python versions
$ tox -e py34,py27  # run all tests against Python 3.4 and 2.7 only
$ ./setup.py -q test -a tests/management  # only run management tests against default python

Der Quellcode soll die flake8 Standardregeln erfüllen (mit Ausnahme der Zeilenlänge, die bis zu 120 Zeichen betragen darf). Ein pre-commit hook für Git wird der Einfachheit halber automatisch installiert, wenn Sie make develop ausführen, somit sollte es nicht einmal möglich sein zu committen, wenn flake8 nicht erfolgreich durchläuft. Zusätzliche statische Analyse wird am QA server durchgeführt und Sie sollten sicherstellen, dass dort der Gesundheitsindikator für den Quellcode mit jedem Beitrag nach oben geht (oder gleichbleibt).

Unterstützung gesucht¶

Schreiben von Tests (Unit Tests, BDD-Tests)
Neue Features auf der Roadmap (siehe README)
Übersetzungen (Blog-Einträge, Dokumentation, Benutzeroberfläche)

Übersetzung¶

Die Übersetzung wird sowohl für die Texte im Quellcode als auch die Dokumentation mit Transifex durchgeführt.

Die mehrsprachige Dokumentation ist in reStructuredText Syntax geschrieben und wird mit Sphinx gebaut. Als Übersetzer können Sie einfach auf Transifex gehen und anfangen, sich für Ihre Sprache ins Zeug zu legen. Einige hilfreiche Hintergrundinformationen gibt es auf Read the Docs und im Transifex support zu lesen.

Versionen erstellen, Packaging, Releases¶

Hinsichtlich der Versionsnummern von django Organice verwenden wir Semantic Versioning. Änderungen von einem zum nächsten Release werden im CHANGELOG dokumentiert.