Contributing
The Docs Feedback Protocol is developed in the open at github.com/fixyourdocs/protocol. Issues and pull requests against the spec, schemas, and examples are welcome.
Developer Certificate of Origin
Section titled “Developer Certificate of Origin”Every commit must be signed off with a Developer Certificate of Origin line. The DCO is a lightweight assertion that you wrote the contribution or otherwise have the right to submit it under the project’s licence. See the full text and rationale on kernel.org.
Sign off your commits with git commit -s. Git will append:
Signed-off-by: Your Name <your.email@example.com>Contributor License Agreement
Section titled “Contributor License Agreement”In addition to the DCO, every contributor must sign the FixYourDocs Individual Contributor License Agreement (based on the Apache ICLA v2.2) the first time they open a pull request. The CLA-assistant bot will comment on your PR with a one-click sign-off link.
The CLA text lives at github.com/fixyourdocs/.github/blob/main/CLA.md.
How to propose a change
Section titled “How to propose a change”- Open an issue first if the change is non-trivial — the editors will confirm scope before you spend time on a PR.
- Spec prose changes go to
spec/v0/README.md. Schema changes go to the matching file underschema/v0/. Keep prose and schema in sync; the schema is normative. - v0 is the stable wire format. Field renames, removals, or non-additive changes require a new major version (see the spec’s §8). Backwards-compatible extensions land via capability tokens.
See CONTRIBUTING.md
in the protocol repo for the full contribution guide.
Licence
Section titled “Licence”The prose in the protocol spec is licensed under CC BY 4.0. The JSON Schema artefacts and code samples are licensed under Apache 2.0.