diff --git a/.github/skills/README.md b/.github/skills/README.md index 803cdb4..30f27b3 100644 --- a/.github/skills/README.md +++ b/.github/skills/README.md @@ -14,6 +14,7 @@ This directory contains the repository-local skills that Copilot can use for Spa ## Intake flow for additional skills 1. Drop raw or draft material into `.github/skills/incoming/`. + - If the raw source currently lives in `dodatki/skills/`, copy or adapt only the selected skill instead of treating the whole folder as active. 2. Review whether it fits the repo rules, stack, and current gate. 3. Adapt it into a clean local skill package under `.github/skills/{skill-name}/`. 4. Update `README.md`, `docs/COPILOT_WORKFLOW.md`, and adoption docs if the skill becomes part of the standard workflow. @@ -22,4 +23,5 @@ This directory contains the repository-local skills that Copilot can use for Spa - Prefer adapted local skills over bulk imports. - Do not treat `incoming/` content as active by default. +- Do not treat `dodatki/skills/` as active by default. - Record activation gates and blockers for every non-trivial skill. diff --git a/.github/skills/incoming/README.md b/.github/skills/incoming/README.md index 5c8d66f..1d4f4d6 100644 --- a/.github/skills/incoming/README.md +++ b/.github/skills/incoming/README.md @@ -5,6 +5,7 @@ Use this directory as the staging area for additional skills before they become ## What goes here - draft skills copied in for review, +- selected skills copied or adapted from `dodatki/skills/`, - external skill references, - partially adapted skill packages, - notes about source, purpose, and gate. diff --git a/README.md b/README.md index 67c0e75..25ff63d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Retro pixel-art game about managing a spaceship mission searching for life. The ## Current status -Pre-initialization / Sprint 0. No production code has been scaffolded yet. The `claude_tips/` folder is treated as reference material, not project source of truth. The `mechanika/` folder is reserved for the final gameplay mechanics specification and currently must not be invented around. +Pre-initialization / Sprint 0. No production code has been scaffolded yet. The `claude_tips/`, `dodatki/research/`, and `dodatki/skills/` folders are treated as reference material, not project source of truth. The `mechanika/` folder is reserved for the final gameplay mechanics specification and currently must not be invented around. ## Approved stack @@ -21,6 +21,7 @@ Pre-initialization / Sprint 0. No production code has been scaffolded yet. The ` ## Documentation - `docs/ARCHITECTURE.md` — approved architecture and integration points for future mechanics. +- `docs/CREATIVE_INPUTS.md` — how to use the new creative research pack and external skill library in `dodatki/`. - `docs/GAME_BRIEF.md` — durable product and mission brief before implementation expands. - `docs/FABULA.md` — story bible and narrative canon kept separate from gameplay rules. - `docs/GDD.md` — structured design document linking brief, fabula, scope, and mechanika placeholders. @@ -30,6 +31,8 @@ Pre-initialization / Sprint 0. No production code has been scaffolded yet. The ` - `docs/ADRs/ADR-001-stack.md` — stack decision record. - `SKILLS_RECOMMENDATIONS.txt` — curated good-plus set of recommended skills and MCP servers for the repo. - `docs/skills-adoption/README.md` — expanded research and adoption order for skills/MCP rollout. +- `dodatki/research/` — creative scientific research pack and prompt flow for later mechanika work. +- `dodatki/skills/` — raw external skill library to review before adapting items into `.github/skills/incoming/`. - `.github/prompts/skills-adoption.prompt.md` — autonomous prompt for executing the skills/MCP adoption plan. - `.github/copilot-instructions.md` — always-on Copilot project rules. - `mechanika/00-template-do-wypelnienia.md` — form to fill in with final gameplay mechanics. @@ -49,6 +52,7 @@ Use the project Copilot assets first, then scaffold the codebase: 3. In Sprint 0, stabilize the docs flow in this order: `/game-dev` → `/game-brief` → `/fabula` → `/gdd` → `/skills-adoption`. 4. Only scaffold the Vite + Phaser project after the documentation and `.github/` assets are in place. 5. Because this repository is still in Sprint 0, there is no `package.json`, no `src/`, and no runnable npm command yet. +6. Treat `dodatki/research/` and `dodatki/skills/` as input libraries; move approved outcomes into `docs/`, `mechanika/`, or `.github/skills/`. ## If the slash commands do not appear diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index cd96e8f..4f80e06 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -110,7 +110,7 @@ When documents overlap, resolve conflicts in this order: 4. `docs/ADRs/` for accepted technical decisions. 5. `docs/ARCHITECTURE.md` for project structure and system boundaries. 6. `.github/copilot-instructions.md` for day-to-day Copilot behavior. -7. `claude_tips/` as reference material only; it is not authoritative. +7. `claude_tips/`, `dodatki/research/`, and `dodatki/skills/` as reference material only; they are not authoritative. ## Core systems diff --git a/docs/COPILOT_WORKFLOW.md b/docs/COPILOT_WORKFLOW.md index a944b5e..bb7d813 100644 --- a/docs/COPILOT_WORKFLOW.md +++ b/docs/COPILOT_WORKFLOW.md @@ -12,6 +12,13 @@ Nie zaczynaj od `/new-scene` albo `/new-system`, jeśli nie masz jeszcze gotoweg W obecnym Sprint 0 przed mechaniką najpierw porządkuj: **brief → fabułę → GDD → adoption skills**. +## Materiały kreatywne poza source of truth + +- `dodatki/research/` traktuj jako pakiet researchowy i kreatywny, nie jako automatycznie zatwierdzoną specyfikację. +- `dodatki/skills/` traktuj jako bibliotekę zewnętrznych skilli do przeglądu. +- Aktywne, repozytoryjne skille nadal mieszkają w `.github/skills/`. +- Jeśli coś z `dodatki/` staje się standardem pracy, zapisz wynik w `docs/`, `mechanika/` albo zaadaptuj skill przez `.github/skills/incoming/`. + ## Co oznaczają nasze przełączniki | Prompt | Kiedy używać | Co robi | @@ -116,6 +123,12 @@ Cel: Copilot ma przypomnieć sobie dokumentację i sprawdzić, czego brakuje. Zanim zaczniesz uszczegóławiać mechanikę, ustaw fundament narracyjny: +Jeśli potrzebujesz materiału wejściowego do tej fazy, najpierw przejrzyj: + +- `dodatki/research/00-RESEARCH-KONTEKST.md` +- `dodatki/research/01-PROPOZYCJE-MECHANIK.md` +- `docs/CREATIVE_INPUTS.md` + ```text /game-brief uporządkuj krótki brief projektu i misji ``` diff --git a/docs/CREATIVE_INPUTS.md b/docs/CREATIVE_INPUTS.md new file mode 100644 index 0000000..5e82407 --- /dev/null +++ b/docs/CREATIVE_INPUTS.md @@ -0,0 +1,69 @@ +# Creative inputs and external reference materials + +## Cel dokumentu + +Ten dokument wyjaśnia, jak korzystać z nowych materiałów w `dodatki/` bez mieszania ich z właściwym source of truth projektu. + +## Krótka zasada + +- `dodatki/research/` = materiał kreatywny i researchowy. +- `dodatki/skills/` = zewnętrzna biblioteka surowych skilli do przeglądu. +- `docs/`, `mechanika/` i `.github/skills/` = właściwe miejsce na zatwierdzone wyniki pracy. + +## Hierarchia ważności + +Gdy materiały się różnią, obowiązuje taka kolejność: + +1. `.github/copilot-instructions.md` +2. `docs/ARCHITECTURE.md`, `docs/SCOPE.md`, `docs/ADRs/` +3. `docs/GAME_BRIEF.md`, `docs/FABULA.md`, `docs/GDD.md` +4. `mechanika/` po jej zatwierdzeniu +5. `dodatki/research/`, `dodatki/skills/`, `claude_tips/` jako materiały pomocnicze + +## `dodatki/research/` + +Ten folder służy jako kreatywny pakiet wejściowy do dalszej pracy nad grą. + +### Aktualna zawartość + +- `00-RESEARCH-KONTEKST.md` — baza naukowa i liczby referencyjne do klimatu oraz przyszłych mechanik. +- `01-PROPOZYCJE-MECHANIK.md` — prompt do iteracji nad wariantami mechanik poza repo. +- `02-IMPLEMENTACJA-W-REPO.md` — prompt do późniejszego wypełniania `mechanika/` po zatwierdzeniu decyzji. + +### Jak używać + +1. Użyj researchu do zbierania inspiracji i pytań projektowych. +2. Zatwierdzone wnioski przepisz do właściwych dokumentów repo. +3. Nie traktuj tego folderu jako automatycznej zgody na nowe mechaniki. +4. Jeśli temat dotyczy kanonu fabularnego, zapisz wynik w `docs/FABULA.md`. +5. Jeśli temat dotyczy briefu lub designu, zapisz wynik w `docs/GAME_BRIEF.md` albo `docs/GDD.md`. +6. Jeśli temat dotyczy finalnych reguł gry, przenieś go dopiero do `mechanika/`. + +## `dodatki/skills/` + +Ten folder przechowuje importowane lub zebrane zewnętrzne skille, które mogą pomóc przy: + +- projektowaniu mechanik, +- pracy nad fabułą i tonem, +- pixel-arcie i prezentacji, +- narzędziach GitHub/workflow, +- szerszym researchu designowym. + +### Ważna zasada + +Skille z `dodatki/skills/` nie są aktywnymi skillami repozytorium tylko dlatego, że zostały tam skopiowane. + +### Jak używać + +1. Wybierz konkretny skill z `dodatki/skills/`. +2. Oceń, czy pasuje do zasad SpaceshipGame i aktualnej bramki projektu. +3. Jeśli ma wejść do workflow, zaadaptuj go do `.github/skills/incoming/`. +4. Dopiero po adaptacji i opisaniu w dokumentacji przenieś go do aktywnego `.github/skills/{nazwa}`. + +## Zalecany przepływ pracy + +1. Przejrzyj `dodatki/research/` jako materiał wejściowy. +2. Uporządkuj decyzje w `docs/GAME_BRIEF.md`, `docs/FABULA.md` i `docs/GDD.md`. +3. Wybierz tylko te skille z `dodatki/skills/`, które realnie wspierają bieżący etap. +4. Adaptuj wybrane skille przez `.github/skills/incoming/`, a nie przez bezpośredni import do aktywnych skilli. +5. Aktualizuj `README.md` i workflow docs, gdy któryś materiał staje się częścią standardowej pracy. diff --git a/docs/skills-adoption/README.md b/docs/skills-adoption/README.md index fecac9e..0972774 100644 --- a/docs/skills-adoption/README.md +++ b/docs/skills-adoption/README.md @@ -17,6 +17,15 @@ Keep candidates only when they support at least one of these needs: Reject or defer candidates when they are primarily Unity, Unreal, Godot, Bevy, Minecraft server, native mobile, game-store automation, or unrelated SaaS automation unless the project later adopts that tool explicitly. +## Current raw source library in this repo + +The repository now also contains `dodatki/skills/` as a raw external skill library and `dodatki/research/` as a creative research pack. + +- Treat both as reference-only inputs. +- Do not treat `dodatki/skills/` as active local skills by default. +- When a specific external skill is worth adopting, stage or adapt it through `.github/skills/incoming/` first. +- Record why that skill fits SpaceshipGame and which project gate allows it. + ## Additional sources checked ### MCP directories and marketplaces