DX: add CONTRIBUTING.md + Forgejo issue/PR templates #37

New issue

Closed

opened 2026-08-30 12:50:38 +02:00 by orkun · 1 comment

orkun commented

2026-08-30 12:50:38 +02:00

Owner

Problem

The repo has no contributor onboarding or Forgejo templates:

No CONTRIBUTING.md — nowhere that documents the dev loop
(bin/x reseed → bin/x bootstrap-cfree → bin/x test), the commit
convention, the code-structure rule (one job per file), or the "no C / no
Python in new tooling" principle.
No issue templates and no PR template — new issues/PRs have no
structure, which shows in the tracker.
No CODEOWNERS, no CODE_OF_CONDUCT.md.

For a project with an unusual toolchain (self-hosted, C-free, bin/x-driven),
the lack of a written contributor guide is a real barrier to entry.

Proposal

CONTRIBUTING.md: environment setup, the bin/x dev loop, how to add a
stdlib namespace / emitter, the code-structure and commit conventions, how the
bootstrap/reseed fixpoint works and how not to break it.
.forgejo/issue_template/: templates for bug, proposal (matches the
existing proposal label workflow), and cleanup/dx.
.forgejo/pull_request_template.md: checklist (tests pass, fmt clean,
bootstrap-cfree green, changeset added once changesets land).
Optional: CODEOWNERS, CODE_OF_CONDUCT.md.

Acceptance criteria

CONTRIBUTING.md covering setup, dev loop, conventions.
Issue + PR templates under .forgejo/.
README links to CONTRIBUTING.

Found during the repository-cleanup / DX pass. Pairs with the git-history/commit
convention issue.

## Problem The repo has **no contributor onboarding or Forgejo templates**: - No `CONTRIBUTING.md` — nowhere that documents the dev loop (`bin/x reseed` → `bin/x bootstrap-cfree` → `bin/x test`), the commit convention, the code-structure rule (one job per file), or the "no C / no Python in new tooling" principle. - No **issue templates** and no **PR template** — new issues/PRs have no structure, which shows in the tracker. - No `CODEOWNERS`, no `CODE_OF_CONDUCT.md`. For a project with an unusual toolchain (self-hosted, C-free, `bin/x`-driven), the lack of a written contributor guide is a real barrier to entry. ## Proposal - **`CONTRIBUTING.md`**: environment setup, the `bin/x` dev loop, how to add a stdlib namespace / emitter, the code-structure and commit conventions, how the bootstrap/reseed fixpoint works and how not to break it. - **`.forgejo/issue_template/`**: templates for `bug`, `proposal` (matches the existing `proposal` label workflow), and `cleanup/dx`. - **`.forgejo/pull_request_template.md`**: checklist (tests pass, fmt clean, bootstrap-cfree green, changeset added once changesets land). - Optional: `CODEOWNERS`, `CODE_OF_CONDUCT.md`. ## Acceptance criteria - [ ] `CONTRIBUTING.md` covering setup, dev loop, conventions. - [ ] Issue + PR templates under `.forgejo/`. - [ ] README links to CONTRIBUTING. Found during the repository-cleanup / DX pass. Pairs with the git-history/commit convention issue.

orkun added the

priority:medium

area:docs

labels 2026-08-30 12:50:38 +02:00

orkun referenced this issue from a commit

2026-08-30 15:46:48 +02:00

docs: add CONTRIBUTING, code of conduct, and Forgejo templates

orkun closed this issue

2026-08-30 15:46:48 +02:00

orkun commented

2026-08-30 15:47:57 +02:00

Author

Owner

Done in 7d64a61.

CONTRIBUTING.md: prerequisites, the bootstrap one-liner, the dev loop (bin/x reseed -> bin/x bootstrap-cfree -> bin/x test), stdlib-addition guidance, and the code/commit conventions (Conventional Commits, ludic-fmt, one-job-per-file, Ludic-not-C/Python/JS for new tooling).
.forgejo/issue_template/: bug, proposal, and cleanup/DX templates.
.forgejo/pull_request_template.md: checklist covering tests, the C-free bootstrap fixpoint, formatting, docs/inventory, and commit style.
Optional extras: .forgejo/CODEOWNERS and a short CODE_OF_CONDUCT.md.
README now links CONTRIBUTING and the templates.

All acceptance criteria met.

Done in 7d64a61. - `CONTRIBUTING.md`: prerequisites, the bootstrap one-liner, the dev loop (`bin/x reseed` -> `bin/x bootstrap-cfree` -> `bin/x test`), stdlib-addition guidance, and the code/commit conventions (Conventional Commits, ludic-fmt, one-job-per-file, Ludic-not-C/Python/JS for new tooling). - `.forgejo/issue_template/`: bug, proposal, and cleanup/DX templates. - `.forgejo/pull_request_template.md`: checklist covering tests, the C-free bootstrap fixpoint, formatting, docs/inventory, and commit style. - Optional extras: `.forgejo/CODEOWNERS` and a short `CODE_OF_CONDUCT.md`. - README now links CONTRIBUTING and the templates. All acceptance criteria met.