Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

README

/README

Tworzy, standaryzuje lub tłumaczy README według szablonu z nagłówkiem, odznakami, wyborem języka i spójnymi sekcjami.

Repozytorium
harness ↗
Licencja
MIT
Ostatnia zmiana repozytorium
08.11.2026

Ocena i bezpieczeństwo

90/ 100Klasa: dobry
Format15 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
2
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 08.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Tworzy, standaryzuje lub tłumaczy README według szablonu z nagłówkiem, odznakami, wyborem języka i spójnymi sekcjami.

Oryginalny opis (EN)

Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.

Jak działa

  1. 1. Inspect the repository
  2. 2. Ask
  3. 3. Resolve the metadata
  4. 4. Write the English README
  5. 5. Write translations
  6. 6. Preserve existing content
  7. 7. Validate
  8. 8. Hand off
  9. Boundaries
Sekcje z nagłówków SKILL.md, w oryginale · 106 linii, 487 słów
Podgląd SKILL.md
---
name: README
description: Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.
---

# README

Write or restructure a README using the template in
`references/template.md`. The English file is canonical; translations mirror its
structure.

## 1. Inspect the repository

Collect:

- existing `README.md`, `README.pt-BR.md`, `README.es.md`;
- the license file and type;
- logo candidates (`assets/logo.png`, `assets/images/logo.png`, `icon.png`, ...);
- the project description from a manifest, if any;
- the default branch and remote (`git remote get-url origin`);
- existing workflows under `.github/workflows/`.

Never infer features. Use what the repository and the user provide.

## 2. Ask

Ask in one round:

1. **Languages**: English only, English + Portuguese, English + Spanish, or all
   three. Default to the languages that already exist; if none, ask.
2. **Logo**: none, or a path. Suggest a detected candidate.
3. **Badges**: CI, Release, Docs, License. Default: Release and License, plus CI
   when `ci.yml` exists, plus Docs when a Pages workflow exists.
4. **Sections**: Features, Requirements, Getting started, Usage, Configuration,
   Development, Testing, Releasing, Contributing, License. Default to the ones
   the repository can support with real content.

Do not add a section you cannot fill truthfully.

## 3. Resolve the metadata

- `owner/repo` from the remote. Accept SSH and HTTPS URLs.
- Project name from the user or the manifest. Use the display name, not the
  package slug.
- One-line description from the user or the manifest.
- License: use the file name (`LICENSE`) and the detected type
  (`MIT`, `Apache-2.0`, ...).

## 4. Write the English README

Follow `references/template.md`:

```html
<div align="center">

<img src="<logo>" alt="<name>" width="200" />

# <name>

<description>

[badges]

[language selector]

</div>
```

Then the chosen sections.

## 5. Write translations

Create `README.pt-BR.md` and/or `README.es.md` only when chosen.

- Mirror the section order and links.
- Translate prose; keep commands, code, file names and URLs unchanged.
- Keep the same language selector in every file, in this order:
  `[English](README.md) | [Português (Brasil)](README.pt-BR.md) | [Español](README.es.md)`
- Do not translate badges, version numbers or brand names.

## 6. Preserve existing content

- Read the current README before writing.
- Keep useful commands, features and notes; move them into the new structure.
- Do not delete content without explicit approval.
- Show a diff before writing when a README already exists.

## 7. Validate

- Title matches the project display name.
- Badge URLs point to the real repository and existing workflows.
- The license badge points to `LICENSE`.
- Every language link points to an existing file.
- Section headings are consistent across languages.
- No secret, token, local path or agent attribution appears.
- Relative links resolve.

## 8. Hand off

Report the files created or changed, the chosen languages, the badges, the
sections included and anything the user must fill in. Do not commit, push or tag
unless the user asks.

## Boundaries

- Never invent features, commands or screenshots.
- Never add a language file without the matching selector entry.
- Never overwrite unrelated sections without approval.
- Never add AI attribution or tool mentions.
Pliki w paczce (2)
  • SKILL.md 3 KB
  • references/template.md 2 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · gabrielSantosLima/harness90MIT
tamaplus/josjis-code100MIT
sorah/config100MIT
Dhananjay-JSR/skills100MIT
Jeff-Kazzee/github-skills100MIT
jasonm4130/claude-skills100MIT
samplexbro/agentsmesh100MIT
tushaarmehtaa/tushar-skills100MIT
samplexbro/agentsmesh100MIT

Migawka bazy z 13.11.2026 · wersja paczki 77ef7e7f93bb (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100configure-readme
    Tworzy README.md z logo, odznakami, listą funkcji i sekcją stosu technologicznego, audytuje brakujące sekcje i dodaje odznaki shields.io.
  • 100readme-docs
    Tworzy lub aktualizuje README projektu według standardu z sekcjami obowiązkowymi, warunkowymi i opcjonalnymi, także po zmianach w kodzie.
  • 100github-repo-readme
    Sprawdza, tworzy lub poprawia README repozytorium z kodu, manifestów i testów, z sekcjami, odznakami i szybkim startem.
  • 100readme-forge
    Tworzy dwujęzyczne README z odznakami, zrzutami z działającego projektu, licencją MIT, CONTRIBUTING i SECURITY oraz ocenia istniejące README.
  • 100ni-readme-guide
    Tworzy, przepisuje i audytuje README repozytoriów GitHub jako zsynchronizowaną parę chińsko-angielską, z linkami między językami, zweryfikowanymi odznakami, grafikami projektu i zwięzłym szybkim startem.
  • 96create-readme
    Generuje lub aktualizuje plik README.md albo CHANGELOG.md projektu.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.