netjes-contributing
/netjes-contributing
Prowadzi zmianę w samym Netjes: od gałęzi i worktree przez testy i dokumentację po prośbę o scalenie, zgodnie z regułami wkładu.
- Autor
- DennisVerhoeven ↗
- Repozytorium
- netjes ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 09.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 1
Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Prowadzi zmianę w samym Netjes: od gałęzi i worktree przez testy i dokumentację po prośbę o scalenie, zgodnie z regułami wkładu.
Oryginalny opis (EN)
Use when making any change to Netjes itself (the C# library, the npm package, the CLI, the template or the examples), from creating the branch to asking for a merge. Covers branch and worktree setup, test-first work, docs, ADRs and commit rules.
Jak działa
- 1. Branch
- 2. Find the shape before the code
- 3. Test first
- 4. Docs and decisions
- 5. Commits
- 6. Ready for review
Podgląd SKILL.md
--- name: netjes-contributing description: Use when making any change to Netjes itself (the C# library, the npm package, the CLI, the template or the examples), from creating the branch to asking for a merge. Covers branch and worktree setup, test-first work, docs, ADRs and commit rules. --- # Making a change to Netjes ## 1. Branch - One branch per change, off `main`: `feat/…`, `fix/…`, `refactor/…`, `docs/…`, `test/…`, `chore/…`. - For parallel work, use a worktree per branch: `git worktree add ../netjes-worktrees/<name> -b <branch> main`, then `npm ci && npm run build` in it. Contributors need Node.js `^22.22.2 || ^24.15.0 || >=26.0.0` (`netjes info` checks it) and the .NET SDK named in `global.json` (10.0.403 or newer). Worktrees share one machine, so only one of them runs an end-to-end suite at a time (see `netjes-verification`). - New scope found along the way gets its own branch. Note it and finish the current one first. ## 2. Find the shape before the code - Read the part of [docs/architecture.md](../../../docs/architecture.md) that covers the area, and the ADRs it links. - Look at both sides. Most features have a C# half (an endpoint convention, the payload, `PageRenderer`) and a JS half (`router.tsx`, `route-tree.tsx`, the Vite plugin, the sidecar). The wire format between them is the payload (`src/Netjes/Rendering/PagePayload.cs` and `packages/netjes/src/payload.ts`); change both together. - When the code resists the change, make a structural `refactor:` commit first, with the suites green before and after. ## 3. Test first 1. Write one test for the next behaviour: - .NET: xUnit in `tests/Netjes.Tests`, usually an endpoint test through the test app helpers, with names like `Thing_Scenario_Outcome`. - JS: Vitest in `packages/netjes/test`, using Testing Library and MSW. - Example behaviour: the example's own tests. 2. Run it and read the failure. It must fail on the behaviour, not on a compile error or a missing import. 3. Make it pass with the smallest change, then run the area's tests. 4. For a fix, the test reproduces the bug. For security-relevant code, add tests for the bypasses too: encodings, casing, alternative code paths, and both the C# and JS sides. 5. Repeat. Commit after each green step. Tests that pin internal details are hard to keep. Assert what an app or a browser can observe: status, headers, payload, rendered DOM. ## 4. Docs and decisions - In the same branch, update the guide that covers the area (`docs/guides/`), the reference pages (`docs/reference/`: the React API, the C# API, options, the CLI and the Vite plugin), `docs/architecture.md` where the mechanism changed, and the package READMEs (`packages/netjes/README.md`, `src/Netjes/README.md`, `src/Netjes.Images.SkiaSharp/README.md`). npm and NuGet resolve no relative link, so those READMEs link files in this repository with absolute URLs on `main` (`https://github.com/DennisVerhoeven/netjes/blob/main/<path>`); the release moves those links to its tag in the packages it publishes, and in this repository `npm test` fails when one of those READMEs has a `blob`, `tree` or `raw.githubusercontent.com` link to any other ref. [docs/README.md](../../../docs/README.md) lists every page; a new page goes in it. A change apps build on also goes in the agent skill (`packages/netjes/skills/netjes/`) and the template's `_AGENTS.md` (the app's `AGENTS.md`). - After changing any of those, run `npm run docs:llms` to regenerate `llms.txt` and `llms-full.txt`, and commit them with the change. It reads only the docs git tracks (and names the ones it left out), so `git add` a new document first. - A new guide goes into one of the groups under `## Guides` in [docs/README.md](../../../docs/README.md), at its place in the order an app is built, and into the Guides entries of `SECTIONS` in `scripts/llms.mjs`, in the same order. A line in any tracked Markdown file that links four or more guides, `CHANGELOG.md` and the decision records included, lists them in that order too. `npm test` fails on a guide that is in no group or in two, and on a list that is out of order. - A decision that a newcomer would not guess, or that was chosen over a real alternative, gets an ADR in `docs/decisions/NNNN-title.md`: Context, Decision, Alternatives considered, Consequences, half a page. Never edit an accepted ADR; write a new one that supersedes it. - Call out every change a running app can notice (a new default, a limit, a header, a removed or renamed API) in the docs. From 0.0.1 on, add it to `CHANGELOG.md` under `## [Unreleased]`, with what an app has to do about it. For a breaking change, also call it out in the merge commit. - Write for outside readers: no personal names, no links to private material, no tool or session references. ## 5. Commits - Conventional subjects, imperative, at most 72 characters, no trailing period. Add a body when the reason isn't obvious from the diff. - Stage explicit paths and check `git diff --cached --stat`; never `git add .`. Never `--no-verify`. - Generated files (`generated/netjes.ts`, the golden files, `llms.txt` and `llms-full.txt`) are regenerated, never edited by hand, and committed with the change that caused them. `UPDATE_GOLDEN=1 dotnet test --project tests/Netjes.Tests` rewrites the typegen golden files, the template's `packages/netjes/template/generated/netjes.ts`, `packages/netjes/test/fixtures/client-render/shell.html`, the client-render shell that the .NET and Vitest suites both check, and the public API listings in `tests/Netjes.Tests/PublicApi/`; review the diff, and make a new public type or member a decision, not a default. ## 6. Ready for review The branch is ready when `netjes-verification`'s gate passes and the diff contains nothing unrelated. A reviewer checks four things: - the change does what it claims (ideally by reproducing it); - the new tests fail with the change reverted; - nothing else regressed; - the docs are accurate. Merge with a merge commit (`--no-ff`) for a branch of several commits, then delete the branch and its worktree.
Wersje
W bazie nie ma innych skilli o nazwie netjes-contributing.
Migawka bazy z 13.11.2026 · wersja paczki 0155e5dc7ada (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
- 100netjes-verification
Sprawdza, czy zmiana w Netjes działa, przed scaleniem gałęzi: zestawy testów, kontrole obrazów i pakietów oraz niestabilne testy. - 100netjes
Pomaga budować i zmieniać aplikację Netjes w React i ASP.NET Core: strony, układy, loadery w C#, endpointy JSON, cache i testy. - 100speclink-worktree-merge
Scala zatwierdzoną zmianę z gałęzi worktree do głównej gałęzi i po scaleniu sprząta worktree. - 100contributing
Prowadzi przez workflow wkładu w Race Condition: konfigurację hooków pre-commit, testy przed PR i wymagania dotyczące stylu kodu. - 95worktree-merge
Scala gotowy worktree do gałęzi domyślnej przez cztery bramki, które w razie błędu blokują scalenie. - 100speclink-worktree-merge
Łączy zacommitowaną zmianę z worktree z główną gałęzią, a następnie usuwa worktree.