feat(HelpOverlay): add Git Notes feature documentation
This update introduces documentation for the Git Notes feature, which allows users to attach additional context to commits without altering the commit history. The new section includes detailed steps, commands, and notes on how to effectively use Git Notes within the application. - Added German and English documentation for Git Notes - Included commands for viewing and managing commit notes - Explained how to fetch and push Git Notes to remote repositories
This commit is contained in:
@@ -547,6 +547,25 @@
|
|||||||
"Restore from commit übernimmt eine ältere Dateiversion ins Arbeitsverzeichnis. Prüfe und committe das Ergebnis anschließend normal.",
|
"Restore from commit übernimmt eine ältere Dateiversion ins Arbeitsverzeichnis. Prüfe und committe das Ergebnis anschließend normal.",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: "app-git-notes",
|
||||||
|
title: "Commits mit Git Notes ergänzen",
|
||||||
|
summary: "Git Notes speichern zusätzliche Informationen zu einem Commit, ohne dessen Hash oder die Historie zu verändern. Sie eignen sich etwa für Review-Hinweise, Ticket-Kontext, Build-IDs oder Freigabestatus.",
|
||||||
|
steps: [
|
||||||
|
"Öffne im Commit-Verlauf über das Notiz-Symbol oder das Kontextmenü die Commit-Notiz.",
|
||||||
|
"Schreibe oder bearbeite die Notiz und speichere sie. Commits mit einer Notiz sind im Verlauf markiert; beim Überfahren der Markierung erscheint eine Vorschau.",
|
||||||
|
"Löschen entfernt nur die Notiz. Der zugehörige Commit und seine Dateien bleiben unverändert.",
|
||||||
|
"Gitty lädt Git Notes im Hintergrund vom bevorzugten Remote. Nutze im Dialog Vom Remote laden, um sie bei Bedarf gezielt zu aktualisieren.",
|
||||||
|
"Nutze Zum Remote senden, um lokale Notizen zu veröffentlichen. Ein normaler Branch-Push überträgt Git Notes nicht automatisch.",
|
||||||
|
],
|
||||||
|
commands: [
|
||||||
|
{ command: "git notes show <commit>", description: "Notiz eines Commits in der Kommandozeile anzeigen" },
|
||||||
|
{ command: "git notes add <commit>", description: "Notiz zu einem Commit hinzufügen oder im Editor verfassen" },
|
||||||
|
{ command: "git fetch <remote> refs/notes/commits:refs/notes/commits", description: "Commit-Notizen gezielt vom Remote laden" },
|
||||||
|
{ command: "git push <remote> refs/notes/commits", description: "Lokale Commit-Notizen zum Remote senden" },
|
||||||
|
],
|
||||||
|
note: "Git Notes liegen standardmäßig unter refs/notes/commits und werden getrennt von Branches synchronisiert. Prüfe vor einem Push, ob der Ziel-Remote diese Referenz akzeptiert.",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
id: "app-search",
|
id: "app-search",
|
||||||
title: "Code-Ursprung mit Global Search finden",
|
title: "Code-Ursprung mit Global Search finden",
|
||||||
@@ -990,6 +1009,25 @@
|
|||||||
"Restore from commit writes an older file version into the working tree. Review and commit the result normally.",
|
"Restore from commit writes an older file version into the working tree. Review and commit the result normally.",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: "app-git-notes",
|
||||||
|
title: "Add context to commits with Git Notes",
|
||||||
|
summary: "Git Notes attach additional information to a commit without changing its hash or rewriting history. They are useful for review findings, ticket context, build IDs, or approval status.",
|
||||||
|
steps: [
|
||||||
|
"Open the commit note from the note icon or the commit context menu in History.",
|
||||||
|
"Write or edit the note and save it. Commits with a note are marked in History, and hovering over the marker shows a preview.",
|
||||||
|
"Deleting removes only the note. The associated commit and its files remain unchanged.",
|
||||||
|
"Gitty fetches Git Notes from the preferred remote in the background. Use Fetch from remote in the dialog to refresh them explicitly when needed.",
|
||||||
|
"Use Push to remote to publish local notes. A regular branch push does not transfer Git Notes automatically.",
|
||||||
|
],
|
||||||
|
commands: [
|
||||||
|
{ command: "git notes show <commit>", description: "Show a commit's note on the command line" },
|
||||||
|
{ command: "git notes add <commit>", description: "Add a note to a commit or compose it in an editor" },
|
||||||
|
{ command: "git fetch <remote> refs/notes/commits:refs/notes/commits", description: "Fetch commit notes explicitly from a remote" },
|
||||||
|
{ command: "git push <remote> refs/notes/commits", description: "Push local commit notes to a remote" },
|
||||||
|
],
|
||||||
|
note: "Git Notes are stored under refs/notes/commits by default and synchronize separately from branches. Before pushing, make sure the destination remote accepts this reference.",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
id: "app-search",
|
id: "app-search",
|
||||||
title: "Find code origins with Global Search",
|
title: "Find code origins with Global Search",
|
||||||
|
|||||||
Reference in New Issue
Block a user