agentleFS
adrian-wulfadrian-wulf/vorarbeiter-code/AGENTS.md

vorarbeiter-code

AGENTS.md2 starsChanged 47 days agoMITView on GitHub

Ten plik czytasz jako pierwszy, zanim zaczniesz jakąkolwiek pracę nad projektem. Zawiera podstawowe zasady, strukturę i to, czego NIE wolno robić bez pytania. <!-- kickoff: wypełnij wszystkie pola w podwójnych nawiasach klamrowych i usuń ten komentarz. --> Nazwa robocza: {{NAZWA}} Typ projektu: {{TYP_PROJEKTU}} Stack: {{STACK}} (szczegóły — patrz ARCHITECTURE.md) Użytkownicy: {{UZYTKOWNICY}} Problem, który rozwiązuje: {{PROBLEM}} Pełny opis wymagań: patrz PRD.md. 1. AGENTS.md (ten plik) — zawsze najpierw 2. PRD.md — co budujemy, dla kogo i po co 3. ARCHITECTURE.md —…

The file

Files
AGENTS.md

AGENTS.md

Ten plik czytasz jako pierwszy, zanim zaczniesz jakąkolwiek pracę nad projektem. Zawiera podstawowe zasady, strukturę i to, czego NIE wolno robić bez pytania.

<!-- kickoff: wypełnij wszystkie pola w podwójnych nawiasach klamrowych i usuń ten komentarz. -->

Czym jest ten projekt

Nazwa robocza: {{NAZWA}}

Typ projektu: {{TYP_PROJEKTU}}

Stack: {{STACK}} (szczegóły — patrz ARCHITECTURE.md)

Użytkownicy: {{UZYTKOWNICY}}

Problem, który rozwiązuje: {{PROBLEM}}

Pełny opis wymagań: patrz PRD.md.

Kolejność czytania dokumentacji

  1. AGENTS.md (ten plik) — zawsze najpierw
  2. PRD.md — co budujemy, dla kogo i po co
  3. ARCHITECTURE.md — jak jest zbudowany projekt, jak uruchomić i testować
  4. ROADMAP.md — na jakim etapie jesteśmy, co jest w zakresie obecnego milestone'a
  5. MODULES/*.md — szczegóły konkretnego modułu, nad którym akurat pracujesz
  6. CODING_STYLE.md — konwencje kodu
  7. UI_STYLE.md — konwencje interfejsu (jeśli projekt ma UI)
  8. GLOSSARY.md — ustalone nazwy domenowe, żeby nie wymyślać nowych terminów
  9. DECISIONS.md — historia decyzji, zanim zaproponujesz coś, co mogło już zostać rozważone i odrzucone

Zasady pracy dla agenta

  • Nie zmieniaj zakresu. Pracuj tylko nad zleconym zadaniem z bieżącego milestone'a w ROADMAP.md.
  • Nie zmieniaj architektury, struktury katalogów ani publicznych interfejsów (API, schemat bazy, format plików) bez wyraźnej zgody — jeśli coś wymaga refaktoru, opisz to w raporcie.
  • Nie dodawaj nowych zależności bez wyraźnego polecenia.
  • Trzymaj się CODING_STYLE.md — nie wprowadzaj własnych konwencji.
  • Nazwy domenowe (encje, pola, komunikaty) — zgodnie z GLOSSARY.md.
  • Sekrety (klucze, hasła, tokeny) nigdy w kodzie ani w repo — tylko zmienne środowiskowe / menedżer sekretów, zgodnie z ARCHITECTURE.md.
  • Istotne decyzje projektowe opisz w raporcie (sekcja „Czego NIE zrobiono / wątpliwości”: co, dlaczego, jakie były alternatywy) — kierownik wpisze je do DECISIONS.md. Nie edytuj dokumentów, jeśli zlecenie tego wprost nie obejmuje.
  • Jeśli czegoś brakuje w dokumentacji, żeby wykonać zadanie — napisz to w raporcie, zamiast zgadywać.

Jak uruchomić / testować

Patrz ARCHITECTURE.md → „Jak uruchomić / testować”. Pełna weryfikacja projektu: bash executor/verify.sh (exit 0 = zielono).

Status dokumentacji

DokumentStatus
AGENTS.md⬜
PRD.md⬜
ARCHITECTURE.md⬜
ROADMAP.md⬜
CODING_STYLE.md⬜
UI_STYLE.md (opcjonalny)⬜
GLOSSARY.md⬜
DECISIONS.md⬜
MODULES/README.md⬜

(Aktualizuj tę tabelę przy tworzeniu/kończeniu każdego dokumentu.)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.