diff options
| author | Nikolay Govorov <me@govorov.online> | 2026-07-24 03:36:10 +0100 |
|---|---|---|
| committer | Nikolay Govorov <me@govorov.online> | 2026-07-24 03:38:51 +0100 |
| commit | 8c2faae6902c928f2dfb39abe39dc7b650695ce8 (patch) | |
| tree | 70d37899e914442757cf03538f9255852b0f0f38 | |
| parent | 1934f5fb264ab046031d5d1b61227de2e1f8dde9 (diff) | |
| download | tar tar.gz tar.bz2 tar.lz tar.xz tar.zst zip | |
Unify contributing policy
Diffstat
| -rw-r--r-- | README.md | 48 | +41 −7 |
1 files changed, 41 insertions, 7 deletions
diff --git a/README.md b/README.md index f7f26b3..a10fee3 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,15 @@ mise run licenses Consuming projects pin this repository by commit SHA. -## Sign-off policy +## Guardrails + +### Licensing policy + +`tasks/licenses` runs a pinned REUSE version and verifies the repository's +licensing metadata and canonical SPDX copyright headers. In Rust projects it +also runs a pinned `cargo deny check`. + +### Sign-off policy `tasks/signoff` verifies that: @@ -35,13 +43,39 @@ Consuming projects pin this repository by commit SHA. Approved emails and unsupported commits are maintained centrally so a pull request in a consuming repository cannot grant itself an exemption. -## Licensing policy +## Contributing -`tasks/licenses` runs a pinned REUSE version and verifies the repository's -licensing metadata and canonical SPDX copyright headers. In Rust projects it -also runs a pinned `cargo deny check`. +We welcome your contributions, including code, bug reports, ideas, and success +stories. + +If you are making a contribution for the first time or from a new email, please +add yourself to the `.mailmap`. + +### Signoff + +To include your code, we ask that you read and agree to the [CLA](./CLA.md). To +sign, add a `CLA-Version: 1.0` and a `Signed-off-by` trailer to every commit +(`git commit -s --trailer "CLA-Version: 1.0"`). Each commit in a pull request +must carry a valid `Signed-off-by` line matching the commit author. Please use +your real name. We cannot include code from anonymous contributors. + +AI agents MUST NOT add Signed-off-by tags. Only humans can legally certify the +Contributor License Agreement. + +### AI policy + +You may use AI agents when writing code and documentation. AI is not allowed for +media including images, videos, fonts at all. You must fully read, understand, +and cleanup any code generated by the agent. We ask that you disclose the +agent's use and indicate the tool, model, and extent of contribution. + +Contributions should include an Assisted-by tag in the following format: +`Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]`, for example: +`Assisted-by: Claude:claude-4.6-opus coccinelle sparse` + +Remember, AI agents should make software better, not worse. -## License +## Licensing Executable tasks and their configuration are licensed under 0BSD. -Documentation is licensed under CC BY 4.0. +Documentation is licensed under CC-BY-4.0. |