The project
The rest of this guide is about the framework. This page is about the project around it: where to ask a question, how a change gets in, who decides, and what someone who finds a vulnerability is promised in return.
The five documents live in
.github/
in the repository, one of the three directories GitHub looks in for them.
- Support. Four doors – bug report, feature request, discussion, private security report – and which one you want depends on what you have. Reading this first is faster than waiting for someone to move your issue.
- Contributing. The build, test and lint gates, what a change is expected to look like, and the shape of commits and releases. Arcature is one crate with an opinion; this says which contributions sharpen it and which do not.
- Security policy. Private reporting through the repository’s Security tab, which versions get fixes, what is in scope, and the response targets a reporter can hold the project to.
- Governance. Arcature has one maintainer, and this says what follows from that – including what happens to the project if that person stops. A bus factor stated plainly is easier to depend on than an org chart nobody staffs.
- Code of conduct. The Contributor Covenant, and the mailbox that enforces it.