add-method
/add-method
Prowadzi krok po kroku przez dodanie nowej metody wyceny do silnika Fairmark: rdzeń, rejestr, schematy, kod Python, dokumentację i testy.
- Autor
- salvo8519 ↗
- Repozytorium
- fairmark ↗
- Licencja
- Apache-2.0
- Ostatnia zmiana repozytorium
- 10.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 10.11.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
Co robi i kiedy
Prowadzi krok po kroku przez dodanie nowej metody wyceny do silnika Fairmark: rdzeń, rejestr, schematy, kod Python, dokumentację i testy.
Oryginalny opis (EN)
End-to-end checklist for adding a valuation method to the Fairmark engine (core, registry, schemas, Python, docs, tests). Use when implementing a new method id.
Jak działa
SKILL.md bez nagłówków drugiego poziomu · 35 linii, 328 słów
Podgląd SKILL.md
---
name: add-method
description: End-to-end checklist for adding a valuation method to the Fairmark engine (core, registry, schemas, Python, docs, tests). Use when implementing a new method id.
---
1. Confirm an `Approved` spec exists and identify its method id (`area.name`).
2. Golden cases first: `/golden-case` for each acceptance criterion with numbers.
3. Core (`crates/fairmark-core/src/<area>.rs`):
- `<Name>Input` with `Serialize, Deserialize, JsonSchema`, `#[serde(deny_unknown_fields)]`,
doc comment on every field with units; optional fields use `#[serde(default)]` and the
default is documented.
- `<Name>Output` with `Serialize, JsonSchema`.
- `pub fn <name>(input: &<Name>Input) -> Result<(<Name>Output, Explain)>` using the checked
helpers of `crate::num`; every visible number is an explain step; conventions listed.
- A unit type `pub struct <Name>;` implementing `Method` (id `<theme>.<name>`, version
"1", title, description, `compute`) in the same module (ADR 0009).
- Unit tests for edge cases and errors.
4. Registry (`registry.rs`): add one line, `<theme>::<Name>`, to the `registry!` list, in its
theme group. Contract cases: `tests/contracts/<id>.yaml` with at least one extreme input and
one conventions case (`crates/fairmark-core/tests/contracts.rs` fails without them).
5. `uv run just generate`: writes `schemas/<id>/v<N>.json`, updates `schemas/index.json`
(`introduced_in: unreleased` until the next release) and the methods reference. Never edit
an earlier version file. Version rule: if the method already exists on `main` at version N,
any numerical change or breaking input change makes it N+1 in this PR, once (several
changes in one PR share the bump); CI refuses a breaking change to version N.
6. Python: thin helper in `python/fairmark/<area>.py`, exported in `__init__.py`.
7. Docs: `docs/en/methods/<id>.md` (via `docs-writer`), nav entry in `zensical.toml`,
row in `docs/en/methods/index.md` (method and what it computes; the status block is
generated); `python scripts/docs_sync.py coverage` must pass. Add the Italian title of the
method to `i18n/method_titles/it.yaml` (short like the English title, terms from
`i18n/glossary.yaml`); `scripts/gen_reference.py` fails without it.
8. `uv run just check`, then `code-reviewer` and `numerical-auditor` once on the branch (a new
method is in the numerical-change tier).
9. Status: a new method is `preview` (ADR 0012). Add its id to the spec's entry in
`specs/method-evidence.yaml`. Promotion to `available` is a separate, maintainer-approved
change: one line in `AVAILABLE` (`registry.rs`) once the rule in
`docs/en/project/releases.md` ("Method status") holds; `python scripts/method_status.py
check` verifies it.
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · salvo8519/fairmark | 92 | Apache-2.0 |
| salvo8519/fairmark | 92 | Apache-2.0 |
Migawka bazy z 13.11.2026 · wersja paczki ab15f501948a (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
- 92golden-case
Pisze złoty przypadek testowy dla metody Fairmark z oczekiwanymi wartościami z niezależnego źródła. - 92golden-case
Pisze złoty przypadek testowy dla metody Fairmark z oczekiwanymi wartościami z niezależnego źródła. - 100add-new-model
Prowadzi krok po kroku przez dodanie nowej architektury modelu do llama.cpp, czyli przeniesienie modelu do tej biblioteki. - 90startup-valuation
Wycenia wczesne firmy z małymi przychodami lub bez nich metodami Berkus, VC i scorecard oraz modeluje rozwodnienie. - 96build-method
Prawdopodobnie prowadzi przez metodę budowania i projektowania oprogramowania.