Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (17 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.8 KB
Raw

Contributing

Contributions are welcome. The workflow is ordinary: an issue describing the change, a short-lived branch, a PR into main that passes make verify.

Developer Certificate of Origin

Every commit must carry a Signed-off-by line matching the commit author:

Signed-off-by: Your Name <you@example.com>

git commit -s adds it for you. The sign-off asserts the Developer Certificate of Origin: you wrote the change or otherwise have the right to submit it under the project license.

To sign off automatically in your clone, run make dco-hook once. It points core.hooksPath at the versioned .githooks/ directory, whose prepare-commit-msg appends the trailer from your git config user.name and user.email when a message does not already have one. Plain git commit is then enough. Undo it with git config --unset core.hooksPath.

Hooks installed this way stay current when you pull, and they do not replace your author identity: set user.name and user.email correctly first, since the hook only adds the trailer.

Forgot on an existing branch? git rebase --signoff main retrofits every commit on it.

Why this project requires it: potocolom is AGPL-3.0 with commercial exceptions sold by the project (COMMERCIAL.md). Dual licensing is only possible while the project retains the right to relicense the whole, so the provenance of every contribution has to be explicit. PRs without sign-off cannot be merged.

Ground rules

  • No emojis or decorative characters in code, comments, commits, issues or PRs.
  • Match the existing style of the file you are editing.
  • Run make verify locally before opening or updating a PR; it runs exactly what CI runs.
  • Mermaid diagrams must render; run make verify-mermaid before pushing.