Skip to main content
Sightmap accepts contributions to the spec, reference implementation, documentation, and website. This page summarizes the process; the files in the sightmap/sightmap repository define the policy.

​
The monorepo

Everything lives in one repository:
github.com/sightmap/sightmap
For the YAML format and its semantics, spec/v1/ is authoritative.

​
Where to discuss

​
Spec changes go through SEPs

Changes such as adding or renaming a field, changing route or merge semantics, or introducing a top-level concept require a Sightmap Enhancement Proposal. The SEP records the design and gives implementations a shared basis for review. spec/seps/README.md defines the scope, numbering, lifecycle, and review windows. AI-assisted contributions (including SEP drafts) are accepted as long as you’ve read the output yourself and can defend it under review.

​
Pull request expectations

  • One concern per PR. If you fix two unrelated bugs, that’s two PRs.
  • Explain why the change is needed. The diff already shows what changed.
  • Update related files in the same PR. If you change a schema field, update spec/v1/schema.md, spec/v1/sightmap.schema.json, and any affected examples.
  • Don’t reformat unrelated code. Keep diffs focused.
  • Expect review. Maintainers aim to provide a first response within three business days.

​
Developer Certificate of Origin

Sightmap does not require a CLA. Every commit needs a Developer Certificate of Origin sign-off confirming that you wrote the contribution or have the right to submit it under the project’s license. Sign off every commit with -s:
This appends a Signed-off-by: Your Name <your@email> trailer to the commit. The name and email must match git config user.name and git config user.email. The DCO check examines every commit on the branch. To sign off the latest commit, amend it:
To add the sign-off to a range of commits, rebase against main. This rewrites history, so force-push with a lease if the branch is already remote:

​
Branch and commit conventions

  • Branch names: feat/<topic>, fix/<topic>, docs/<topic>, spec/<topic>, or sep/<number>-<slug> for SEP drafts.
  • Commit messages: short imperative subject, optional body explaining why. Conventional Commits welcome but not required.
  • Every commit ends with Signed-off-by: ….

​
License

By contributing, you agree that your contributions will be licensed under the project’s MIT License.

​
Canonical documents