docs: write commit messages in English from now on
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>
This commit is contained in:
1 parent
86f1fae02a
commit
4761624fbe
3 files changed
+3
-3
No files matched your search
+1
-1
@@ -27,7 +27,7 @@ Das Hauptrepository liegt auf **Gitea**: <https://gitea.pansi.eu/harald/ink-note
|
||||
```
|
||||
3. Neue Funktionen und behobene Fehler bekommen einen Test, wo das sinnvoll geht.
|
||||
4. Änderungen am Dateiformat bitte in [docs/FILE_FORMAT.de.md](docs/FILE_FORMAT.de.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)`. Neue Code-Kommentare werden auf Englisch geschrieben (älterer Code hat noch deutsche Kommentare); Commit-Nachrichten auf Deutsch.
|
||||
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)`. Neue Code-Kommentare und Commit-Nachrichten werden auf Englisch geschrieben (älterer Code und die Historie enthalten noch Deutsch).
|
||||
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).
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ The main repository is on **Gitea**: <https://gitea.pansi.eu/harald/ink-notes>.
|
||||
```
|
||||
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)`. New code comments are written in English (older code still has German comments); commit messages are in German.
|
||||
5. Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/), e.g. `fix: …`, `feat: …`, `perf: …`, `docs: …`; refer to an issue as `(Issue #28)`. New code comments and commit messages are written in English (older code and history still contain 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).
|
||||
@@ -147,7 +147,7 @@ cargo test # unit and integration tests
|
||||
|
||||
CI additionally checks `cargo fmt --check` and `cargo clippy --all-targets -- -D warnings`.
|
||||
|
||||
New code comments are written in English; older code still has German comments.
|
||||
New code comments and commit messages are written in English; older code and history still contain German.
|
||||
|
||||
### Project structure
|
||||
|
||||
|
||||
Reference in new issue
Block a user