Toolverse
All skills

contributing-guide-creator

by jeremylongshore

Contributing Guide Creator - Auto-activating skill for Technical Documentation.\nTriggers on: contributing guide creator, contributing guide creator\nPart of the Technical Documentation skill category.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Security
Views
1

About this skill

Contributing Guide Creator - Auto-activating skill for Technical Documentation.\nTriggers on: contributing guide creator, contributing guide creator\nPart of the Technical Documentation skill category.

How to use

  1. Aktywuj umiejętność, pisząc w prośbie do Claude'a frazę "contributing guide creator" lub pytając o pomoc z przewodnikami dla współtwórców.
  2. Opisz strukturę Twojego projektu, jego główne komponenty oraz proces, który powinni śledzić nowi współtwórcy (np. fork, branch, pull request).
  3. Claude wygeneruje kompletny przewodnik zawierający instrukcje instalacji środowiska, wytyczne dotyczące stylu kodu, proces zgłaszania zmian i wymagane testy.
  4. Przejrzyj wygenerowaną zawartość i dostosuj ją do specyficznych potrzeb Twojego projektu, na przykład dodając linki do dokumentacji lub zmień wymagania dotyczące testów.
  5. Umiejętność zweryfikuje przewodnik pod kątem zgodności z powszechnymi standardami dokumentacji technicznej i best practices.
  6. Zapisz ostateczną wersję przewodnika w repozytorium jako plik CONTRIBUTING.md lub CONTRIBUTING.rst, aby był dostępny dla wszystkich potencjalnych współtwórców.

Related skills