Contributing Guidelines

How to choose the right repo, keep scope tight, and ship changes that are easy to trust.

by @saifyxpro

Choose the right repository

  • use HeadlessX for product runtime, API, worker, dashboard, and infrastructure changes

Keep changes coherent

  • one problem per branch when possible
  • keep unrelated cleanup out of feature work
  • update docs when user-facing behavior changes

If you change routes or setup

Update the relevant references in the same pass:

  • docs pages
  • README sections
  • setup instructions
  • endpoint references

Communication standard

A strong contribution leaves behind:

  • a clear commit message
  • a clear PR description
  • verification notes
  • explicit mention of any remaining gaps