CONTRIBUTING (en/de) and README now state that new code comments and commit messages are written in English. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.2 KiB
2.2 KiB
Mitmachen bei ink-notes
English · Deutsch
Danke, dass du ink-notes verbessern willst!
Wo?
Das Hauptrepository liegt auf Gitea: https://gitea.pansi.eu/harald/ink-notes. GitHub ist ein Spiegel davon – Issues und Pull Requests sind dort auch willkommen, Pull Requests werden aber von Hand nach Gitea übernommen.
Fehler melden und Ideen vorschlagen
- Bitte zuerst nachsehen, ob es schon ein Issue dazu gibt.
- Für Fehler die Vorlage „Fehler melden“ verwenden: Version (☰ → Updates), Distribution, Wayland oder X11, Eingabegerät (Stift, Finger, Maus, Touchpad) und die Schritte, mit denen der Fehler auftritt. Ein Bildschirmfoto oder eine kurze Aufnahme hilft oft sehr.
- Deutsch und Englisch sind beide in Ordnung.
- Sicherheitslücken bitte nicht öffentlich melden, sondern wie in SECURITY.de.md beschrieben.
Code beitragen
- Größere Änderungen am besten vorher in einem Issue absprechen.
- Bauen und testen, wie im README beschrieben. Vor dem Einreichen müssen diese Prüfungen durchlaufen (die CI prüft sie ebenfalls):
cargo fmt --check cargo clippy --all-targets -- -D warnings cargo test - Neue Funktionen und behobene Fehler bekommen einen Test, wo das sinnvoll geht.
- Änderungen am Dateiformat bitte in docs/FILE_FORMAT.de.md nachtragen; ältere Notizbücher müssen weiter lesbar bleiben.
- Commit-Nachrichten im Stil von Conventional Commits, z. B.
fix: …,feat: …,perf: …,docs: …; ein Bezug auf ein Issue als(Issue #28). Neue Code-Kommentare und Commit-Nachrichten werden auf Englisch geschrieben (älterer Code und die Historie enthalten noch Deutsch). - Texte der Oberfläche gibt es auf Deutsch und Englisch: Neue Texte mit
t!("…")schreiben und die englische Übersetzung untersrc/i18n/ergänzen.
Mit dem Einreichen stimmst du zu, dass dein Beitrag unter der MIT-Lizenz des Projekts steht. Für den Umgang miteinander gilt der Code of Conduct.