Develop Contribution
Create or regularize one contributions/<slug>/ folder: badge-general
compliant, self-contained, with a report/report.tex detailed enough that
paper writing never needs to re-read the code.
Read First
contributions/README.md — the badge-general contract
survey/survey.pdf, gaps section — when positioning a new contribution
references/methodology.md — evaluation, statistics, figure discipline
references/experiments.md — run logs and autonomous campaigns
references/reproduction.md — reproducing external work
references/ethics.md — data red flags
references/data.md — data placement and inter-contribution data
dependencies (when the contribution has shared/large data or consumes
another contribution's output)
Before Building (both modes)
Fill the Positioning section of the contribution README:
- the claim this contribution will support
- the delta vs the nearest prior work (cite survey/SOTA citekeys)
- the evidence plan: what will be measured or collected, and how
- the falsifiability condition: what outcome would refute the claim
If the claim has no evidence path, stop and discuss with the user.
Create Mode
- Copy
contributions/_template/ to contributions/<slug>/ (kebab-case
slug).
- Python code? Write the contribution's own
pyproject.toml (name,
requires-python, dependencies), add "contributions/<slug>" to
[tool.uv.workspace] members in the root pyproject.toml, run
uv sync --all-packages from the root (plain uv sync prunes the
members' dependencies on a package = false root). Genuinely conflicting
dependencies → move the path to exclude, create a local venv, document
it in the README.
- Develop inside the folder — free-form structure (
src/, data/,
figures/, outputs/, notebooks). Follow references/methodology.md
for any evaluation; keep a run log per references/experiments.md for
every run that supports a claim, including autonomous campaigns. For
reproductions of external work, follow references/reproduction.md.
- Fill the README badge checklist truthfully — every checked box has
evidence inside the folder. Check data against
references/ethics.md.
- Write
report/report.tex: motivation, positioning vs the SOTA (cite the
root .bib), method, setup, results with figures/tables, limitations.
Build it: make contribution C=<slug>.
- Run
make check.
Regularize Mode
- Inventory the draft folder: what exists, what it claims, what is missing
against the badge checklist.
- Reorganize in place — keep provenance (note original filenames when
renaming), capture the environment, verify the run path works
end-to-end, record data provenance and ethics flags.
- Continue with Create Mode steps 4–6.
Rules
- Self-contained: no imports from other contributions; tooling worth
sharing becomes its own contribution referenced in the README. If the input
is another contribution's output, declare it and read it in place — never
copy (see
references/data.md).
- Exploratory results never masquerade as confirmed evidence — label them.
- Negative results are results: report them in report.tex.
Done When
- Badge checklist fully and truthfully checked,
report.pdf built,
workspace coherent, make check passes
1---2name: develop-contribution3description: Use when creating a new contribution (analysis, experiment, dataset, software, reproduction) or regularizing a draft folder into badge compliance with its LaTeX report.4license: MIT5---67# Develop Contribution89Create or regularize one `contributions/<slug>/` folder: badge-general10compliant, self-contained, with a `report/report.tex` detailed enough that11paper writing never needs to re-read the code.1213## Read First1415- `contributions/README.md` — the badge-general contract16- `survey/survey.pdf`, gaps section — when positioning a new contribution17- `references/methodology.md` — evaluation, statistics, figure discipline18- `references/experiments.md` — run logs and autonomous campaigns19- `references/reproduction.md` — reproducing external work20- `references/ethics.md` — data red flags21- `references/data.md` — data placement and inter-contribution data22 dependencies (when the contribution has shared/large data or consumes23 another contribution's output)2425## Before Building (both modes)2627Fill the Positioning section of the contribution README:2829- the claim this contribution will support30- the delta vs the nearest prior work (cite survey/SOTA citekeys)31- the evidence plan: what will be measured or collected, and how32- the falsifiability condition: what outcome would refute the claim3334If the claim has no evidence path, stop and discuss with the user.3536## Create Mode37381. Copy `contributions/_template/` to `contributions/<slug>/` (kebab-case39 slug).402. Python code? Write the contribution's own `pyproject.toml` (name,41 requires-python, dependencies), add `"contributions/<slug>"` to42 `[tool.uv.workspace] members` in the root `pyproject.toml`, run43 `uv sync --all-packages` from the root (plain `uv sync` prunes the44 members' dependencies on a `package = false` root). Genuinely conflicting45 dependencies → move the path to `exclude`, create a local venv, document46 it in the README.473. Develop inside the folder — free-form structure (`src/`, `data/`,48 `figures/`, `outputs/`, notebooks). Follow `references/methodology.md`49 for any evaluation; keep a run log per `references/experiments.md` for50 every run that supports a claim, including autonomous campaigns. For51 reproductions of external work, follow `references/reproduction.md`.524. Fill the README badge checklist truthfully — every checked box has53 evidence inside the folder. Check data against `references/ethics.md`.545. Write `report/report.tex`: motivation, positioning vs the SOTA (cite the55 root `.bib`), method, setup, results with figures/tables, limitations.56 Build it: `make contribution C=<slug>`.576. Run `make check`.5859## Regularize Mode60611. Inventory the draft folder: what exists, what it claims, what is missing62 against the badge checklist.632. Reorganize in place — keep provenance (note original filenames when64 renaming), capture the environment, verify the run path works65 end-to-end, record data provenance and ethics flags.663. Continue with Create Mode steps 4–6.6768## Rules6970- Self-contained: no imports from other contributions; tooling worth71 sharing becomes its own contribution referenced in the README. If the input72 is another contribution's output, declare it and read it in place — never73 copy (see `references/data.md`).74- Exploratory results never masquerade as confirmed evidence — label them.75- Negative results are results: report them in report.tex.7677## Done When7879- Badge checklist fully and truthfully checked, `report.pdf` built,80 workspace coherent, `make check` passes