docs: Dokumentation auf Englisch, deutsche Fassungen als *.de.md
CONTRIBUTING, SECURITY, docs/ARCHITECTURE und docs/FILE_FORMAT sind jetzt englisch; die deutschen Fassungen bleiben als *.de.md erhalten und verlinken sich gegenseitig. Inhaltlich nachgezogen: Live-Strich mit gleicher Tessellierung, runde Ecken, Nachgleiten, eingerasteter Textmarker, Farben im Dateiformat sind sRGB. Kommentare im Flatpak-Manifest auf Englisch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
023991d0a3
commit
7cf315967a
11 files changed
+698
-245
No files matched your search
+19
-29
@@ -1,43 +1,33 @@
|
||||
# Mitmachen bei ink-notes
|
||||
# Contributing to ink-notes
|
||||
|
||||
Danke, dass du ink-notes verbessern willst! *(English below.)*
|
||||
**English** · [Deutsch](CONTRIBUTING.de.md)
|
||||
|
||||
## Wo?
|
||||
Thank you for wanting to improve ink-notes!
|
||||
|
||||
Das Hauptrepository liegt auf **Gitea**: <https://gitea.pansi.eu/harald/ink-notes>.
|
||||
[GitHub](https://github.com/haraldpansi-gif/ink-notes) ist ein Spiegel davon – Issues und Pull Requests sind dort auch willkommen, Pull Requests werden aber von Hand nach Gitea übernommen.
|
||||
## Where?
|
||||
|
||||
## Fehler melden und Ideen vorschlagen
|
||||
The main repository is on **Gitea**: <https://gitea.pansi.eu/harald/ink-notes>.
|
||||
[GitHub](https://github.com/haraldpansi-gif/ink-notes) is a mirror – issues and pull requests are welcome there too, but pull requests are applied to Gitea by hand.
|
||||
|
||||
- Bitte zuerst nachsehen, ob es schon ein [Issue](https://gitea.pansi.eu/harald/ink-notes/issues) 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.md](SECURITY.md) beschrieben.
|
||||
## Reporting bugs and suggesting ideas
|
||||
|
||||
## Code beitragen
|
||||
- Please check first whether there is already an [issue](https://gitea.pansi.eu/harald/ink-notes/issues) for it.
|
||||
- For bugs, use the "Bug report" template: version (☰ → Updates), distribution, Wayland or X11, input device (pen, finger, mouse, touchpad) and the steps that trigger the bug. A screenshot or a short recording often helps a lot.
|
||||
- English and German are both fine.
|
||||
- **Please do not report security vulnerabilities publicly**; follow [SECURITY.md](SECURITY.md) instead.
|
||||
|
||||
1. Größere Änderungen am besten vorher in einem Issue absprechen.
|
||||
2. Bauen und testen, wie im [README](README.de.md#entwicklung) beschrieben. Vor dem Einreichen müssen diese Prüfungen durchlaufen (die CI prüft sie ebenfalls):
|
||||
## Contributing code
|
||||
|
||||
1. Discuss larger changes in an issue first.
|
||||
2. Build and test as described in the [README](README.md#development). These checks must pass before submitting (CI checks them too):
|
||||
```bash
|
||||
cargo fmt --check
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
cargo test
|
||||
```
|
||||
3. Neue Funktionen und behobene Fehler bekommen einen Test, wo das sinnvoll geht.
|
||||
4. Änderungen am Dateiformat bitte in [docs/FILE_FORMAT.md](docs/FILE_FORMAT.md) nachtragen; ältere Notizbücher müssen weiter lesbar bleiben.
|
||||
5. Commit-Nachrichten im Stil von [Conventional Commits](https://www.conventionalcommits.org/), z. B. `fix: …`, `feat: …`, `perf: …`, `docs: …`; ein Bezug auf ein Issue als `(Issue #28)`.
|
||||
6. Texte der Oberfläche gibt es auf Deutsch und Englisch: Neue Texte mit `t!("…")` schreiben und die englische Übersetzung unter `src/i18n/` ergänzen.
|
||||
|
||||
Mit dem Einreichen stimmst du zu, dass dein Beitrag unter der [MIT-Lizenz](LICENSE) des Projekts steht. Für den Umgang miteinander gilt der [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
---
|
||||
|
||||
## Contributing (English)
|
||||
|
||||
The main repository is on **Gitea**: <https://gitea.pansi.eu/harald/ink-notes>. [GitHub](https://github.com/haraldpansi-gif/ink-notes) is a mirror; issues and pull requests are welcome there too, but pull requests are applied to Gitea by hand.
|
||||
|
||||
- **Bugs and ideas:** check the [existing issues](https://gitea.pansi.eu/harald/ink-notes/issues) first, then use the bug report or feature request template. Please include the version (☰ → Updates), distribution, Wayland or X11, the input device and the steps to reproduce. German and English are both fine.
|
||||
- **Security issues:** please do not report them publicly; see [SECURITY.md](SECURITY.md).
|
||||
- **Code:** discuss larger changes in an issue first. Before submitting, `cargo fmt --check`, `cargo clippy --all-targets -- -D warnings` and `cargo test` must pass. Add tests where it makes sense, document file format changes in `docs/FILE_FORMAT.md`, use Conventional Commits, and add English translations for new UI texts (`t!("…")`, see `src/i18n/`).
|
||||
3. New features and bug fixes get a test where that makes sense.
|
||||
4. Document changes to the file format in [docs/FILE_FORMAT.md](docs/FILE_FORMAT.md) (and its German version); older notebooks must remain readable.
|
||||
5. Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/), e.g. `fix: …`, `feat: …`, `perf: …`, `docs: …`; refer to an issue as `(Issue #28)`. Code comments and commit messages in this project are written in German.
|
||||
6. The interface is available in German and English: write new texts with `t!("…")` (the German text is the key) and add the English translation in `src/i18n/`.
|
||||
|
||||
By contributing you agree that your contribution is licensed under the project's [MIT License](LICENSE). Everyone taking part is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
Reference in new issue
Block a user