Skip to content

docs: future-proof the contributor docs for a growing team #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MatejGomboc wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −4
Open

docs: future-proof the contributor docs for a growing team #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ Release codenames follow the six Noongar seasons — Birak, Bunuru, Djeran, Maku

### Changed

- Contributor documents no longer assume a permanent team of one. `SECURITY.md`, `CONTRIBUTING.md` and
`CLAUDE.md` now say "deliberately small team" — the project anticipates at least one more member, and
a document that promises "one maintainer" would start lying the day they join. The constitution's §5
is deliberately untouched: its wording is role-based ("the maintainer") and still true, and the real
§5 amendment — who reviews, who may merge — depends on the member's actual role, which is the
maintainer's to write when that person exists.
- **The docs repository was merged into this repository, history and all.** The constitution now lives
at `CONSTITUTION.md` in the repository root, bound into every session by the repo-root `CLAUDE.md`;
RFCs and the documents' changelog live under `docs/`. The import was a true history merge rather than
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Drivers, filesystem, libc and the network stack are all *port* verdicts in the
constitution's Borrow Ledger, and they will eventually want their own repos.
They start life as members of this Cargo workspace instead, because the HAL and
IPC ABI are still moving: splitting them out now would turn every interface
change into a synchronised multi-repo dance for a single maintainer. Promote
change into a synchronised multi-repo dance for a deliberately small team. Promote
them out once the ABI stops moving — Phase 2 or 3, not before.

Vendored MIT-licensed code (Redox and similar) goes under `vendor/`, one
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,4 +300,4 @@ Update `CHANGELOG.md`'s `[Unreleased]` section for all notable changes, and bump

- Design questions belong in [discussions](https://github.com/setonix-os/kernel/discussions) or an RFC
- Check existing issues first
- Be patient — this is a one-maintainer project by design
- Be patient — Setonix is a deliberately small team, and every change crosses the maintainer's desk
4 changes: 2 additions & 2 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Please include:
- Steps to reproduce, ideally with a QEMU command line
- Which Tier-1 architecture you observed it on, and whether the other is affected

You will get an acknowledgement within a week. This is a one-maintainer project, so please be patient
with the timeline for a fix — but the acknowledgement will not be silent.
You will get an acknowledgement within a week. Setonix is a deliberately small team, so please be
patient with the timeline for a fix — but the acknowledgement will not be silent.

## Supported Versions

Expand Down