Pythonia
Willkommen bei Pythonia - The Python Funktions Collection Repository! Dies ist ein öffentliches Repository, in dem jeder seine Python -Funktionen beisteuern kann. Unabhängig davon, ob es sich um ein einzelnes Skript oder ein komplexeres Projekt unterteilt ist, das in mehrere Dateien unterteilt ist, sind Ihre Beiträge willkommen.
Inhaltsverzeichnis
- Um
- Wie man beiträgt
- Richtlinien
- Ordnerstruktur
- Lizenz
- Beitragen
Um
Dieses Repository ist eine Sammlung verschiedener Python -Funktionen und Skripte. Ziel ist es, verschiedene nützliche Funktionen zu schaffen, die anderen Entwicklern und Enthusiasten helfen können. Beiträge können von einfachen Nutzfunktionen bis hin zu komplexeren Projekten reichen.
Wie man beiträgt
Der Beitrag zu diesem Repository ist einfach. Befolgen Sie die folgenden Schritte, um loszulegen:
- Geben Sie das Repository auf : Klicken Sie oben rechts auf die Schaltfläche
Fork oben rechts. - Klonen Sie Ihre Gabel : Klonen Sie Ihr Gabel -Repository in Ihre lokale Maschine.
git clone https://github.com/ < your-username > /python-functions-collection.git
- ** Erstellen Sie einen neuen Zweig: Erstellen Sie eine neue Zweigstelle für Ihre Beiträge.
git checkout -b my-new-function
- Fügen Sie Ihre Funktion hinzu: Fügen Sie Ihre Python -Funktion (n) dem entsprechenden Ordner hinzu oder erstellen Sie eine neue.
- Verpflichten Sie Ihre Änderungen: Verpflichten Sie Ihre Änderungen mit einer aussagekräftigen Commit -Botschaft.
git add .
git commit -m " Add new function for XYZ "
- Drücken Sie auf Ihre Gabel: Drücken Sie Ihre Änderungen in Ihr Forked Repository.
git push origin my-new-function
- Erstellen Sie eine Pull -Anfrage: Gehen Sie zum ursprünglichen Repository und klicken Sie auf die Schaltfläche
New Pull Request . - Aktualisieren Sie auch "Anforderungen.txt" -Datei gemäß Ihrem Projekt.
Richtlinien
Um sicherzustellen, dass das Repository organisiert und nützlich bleibt, befolgen Sie diese Richtlinien, wenn Sie einen Beitrag leisten:
- Organisieren Sie Code in Ordnern: Wenn Ihr Beitrag aus mehreren Dateien oder Teilen besteht, platzieren Sie sie in einem Ordner. Nennen Sie den Ordner deskriptiv.
- Einzeldateibeiträge: Wenn Ihr Beitrag eine einzige Python -Datei ist, legen Sie sie direkt in den entsprechenden Abschnitt ein.
- Benennung von Konventionen: Verwenden Sie beschreibende Namen für Dateien und Ordner. Vermeiden Sie generische Namen wie script.py oder function.py.
- Dokumentation: Fügen Sie Kommentare und Docstrings in Ihren Code ein, um deren Funktionalität zu erklären.
- Testen: Geben Sie nach Möglichkeit ein kleines Testskript oder ein Beispiel an, das zeigt, wie Sie Ihre Funktion verwenden.
- Lizenzinformationen: Stellen Sie sicher, dass Ihre Beiträge mit der Lizenz des Repositorys kompatibel sind (siehe unten).
Ordnerstruktur
Organisieren Sie das Repository auf sinnvolle Weise. Hier ist eine Beispielstruktur:
Pytonia/
|
| -- single_file_functions/
| | -- example_function.py
|
| -- multi_part_functions/
| | -- project_name/
| | -- part1.py
| | -- part2.py
| | -- README.md
|
| -- README.md
- Single_file_functions: Für einzelne Python -Dateibeiträge.
- multi_part_functions: Für Projekte mit mehreren Teilen/Dateien. Jedes Projekt sollte einen eigenen Ordner haben.
- Readme.md: Diese Datei.
Lizenz
Dieses Projekt ist unter der MIT -Lizenz lizenziert. Durch den Beitrag stimmen Sie zu, dass Ihre Beiträge im Rahmen der MIT -Lizenz lizenziert werden.
Beitragen
Wir begrüßen Beiträge von allen. So können Sie helfen:
- Fehlerberichte und Feature -Anfragen senden: Verwenden Sie den Problemverfolger, um Fehler zu melden oder Funktionen vorzuschlagen.
- Überprüfen Sie Pull -Anfragen: Überprüfen Sie die Pull -Anfragen von anderen Mitwirkenden.
- Verbesserung der Dokumentation: Verbesserung dieser Readme, fügen Sie Kommentare hinzu und verbessern Sie die Code -Dokumentation.
