Fähigkeiten github-release-assistant

📦

github-release-assistant

Name: github-release-assistant
Author: ZhanlinCui

Sicher

Bilinguale GitHub Release-Dokumentation generieren

Das Erstellen polierter Release-Dokumentation braucht Zeit und erfordert Konsistenz über Sprachen hinweg. Diese Fähigkeit automatisiert die Generierung bilingualer README-Dateien aus Ihren vorhandenen Repository-Metadaten.

Unterstützt: Claude Codex Code(CC)

🥇 84 Gold

Die Skill-ZIP herunterladen

In Claude hochladen

Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen

Einschalten und loslegen

Teste es

Verwendung von "github-release-assistant". Repository mit config.json enthaltend Projektmetadaten und einer requirements.txt Datei

Erwartetes Ergebnis:

Zwei Dateien erstellt: README.md (Englisch) und README.zh.md (Chinesisch) mit übereinstimmender Struktur einschließlich Projektübersicht, Hauptfunktionen, Quickstart-Anweisungen und Lizenz-Badges

Verwendung von "github-release-assistant". Generator mit --language both --overwrite Flags auf vorhandener Dokumentation ausführen

Erwartetes Ergebnis:

Aktualisierte README-Dateien ersetzen vorherige Versionen und bewahren dabei die git-Historie durch staged Changes zur Überprüfung

Sicherheitsaudit

Sicher

v1 • 2/24/2026

Static analysis flagged 53 patterns but all are false positives. The 'weak cryptographic algorithm' warnings match MATLAB function names (BDF1, BDF2, ode45) in documentation, not actual crypto code. 'Ruby backtick execution' is Python code with markdown documentation formatting. Hardcoded URLs are standard badge images from shields.io. Unicode regex detects CJK characters for bilingual support. No malicious intent, no credential handling, no external API calls beyond static badge URLs.

Gescannte Dateien

676

Analysierte Zeilen

befunde

Gesamtzahl Audits

Keine Sicherheitsprobleme gefunden

Auditiert von: claude

Qualitätsbewertung

Architektur

100

Wartbarkeit

Inhalt

Community

100

Sicherheit

Spezifikationskonformität

Was du bauen kannst

Open Source Projekt Maintainer

Generiert konsistente bilinguale Release-Dokumentation für jeden GitHub-Versionsrelease ohne manuelles Schreiben beider Sprachversionen.

Internationaler Entwickler

Erstellt schnell chinesische und englische README-Dateien für Projekte, die sich an inländische und internationale Zielgruppen richten.

Forschungscode-Verteilung

Erzeugt professionelle Dokumentation für akademische Software-Releases mit klarer Abschnittsstruktur und Installationsanweisungen.

Probiere diese Prompts

Grundlegende README-Generierung

Generieren Sie bilinguale README-Dateien für mein Repository unter Verwendung des Standard-Templates.

Benutzerdefinierte Konfiguration

Erstellen Sie README.md und README.zh.md unter Verwendung der Einstellungen in release_assistant.json für Projektname, Features und Quickstart-Schritte.

Selektive Sprachausgabe

Generieren Sie nur die chinesische README (README.zh.md) unter Verwendung vorhandener Projektmetadaten und überschreiben Sie existierende Dateien.

Vollständiger Release-Workflow

Generieren Sie beide README-Dateien, zeigen Sie mir den git diff und führen Sie mich dann durch das Committen und Pushen der Änderungen mit einer passenden Commit-Nachricht.

Bewährte Verfahren

Überprüfen Sie generierten README-Inhalt vor dem Committen, um Genauigkeit der extrahierten Metadaten sicherzustellen
Erstellen Sie release_assistant.json mit benutzerdefinierten Projektdetails für konsistente Ausgabe über Releases hinweg
Verwenden Sie git diff, um Änderungen vor der Ausführung von git add und Commit-Operationen zu überprüfen

Vermeiden

Committen Sie keine generierten README-Dateien ohne Überprüfung des extrahierten Inhalts auf Genauigkeit
Vermeiden Sie die Verwendung des --overwrite Flags, es sei denn, Sie beabsichtigen, vorhandene Dokumentation vollständig zu ersetzen
Führen Sie git push nicht aus, ohne zuerst zu überprüfen, dass der Diff nur beabsichtigte Dokumentationsänderungen zeigt

Häufig gestellte Fragen

Welche Dateien benötigt diese Fähigkeit zur Generierung von Dokumentation?

Die Fähigkeit liest config.json, README.md, PROJECT_STRUCTURE.md, requirements.txt und LICENSE aus Ihrem Repository. Mindestens wird ein Repo-Verzeichnis benötigt, um den Projektnamen zu extrahieren.

Kann ich das README-Template anpassen?

Ja, bearbeiten Sie die Template-Dateien in assets/readme_template_en.md und assets/readme_template_zh.md oder stellen Sie benutzerdefinierte Templates über das --template-dir Flag bereit.

Erstellt diese Fähigkeit tatsächliche GitHub Releases?

Nein, es generiert nur README-Dokumentationsdateien. Das Erstellen von GitHub Releases über API erfordert zusätzliche Berechtigungen und liegt außerhalb des Umfangs dieser Fähigkeit.

Wie geht die Fähigkeit mit bilingualem Inhalt um?

Es erkennt chinesische/japanische/koreanische Zeichen mittels Regex und extrahiert Inhalt aus vorhandener Dokumentation, oder verwendet bereitgestellte Konfigurationswerte für sowohl englische als auch chinesische Abschnitte.

Was ist, wenn mein Projekt ein anderes Konfigurationsformat verwendet?

Erstellen Sie eine release_assistant.json Datei im Root-Verzeichnis Ihres Repos nach dem Beispiel in assets/release_config.example.json, um benutzerdefinierte Metadaten bereitzustellen.

Wird mein Code während der Generierung an externe Server gesendet?

Nein, die gesamte Verarbeitung erfolgt lokal. Die einzigen externen URLs sind statische Badge-Bilder von shields.io, die im generierten README-Markdown eingebettet sind.