Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (32 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

39 lines (32 loc) · 1.79 KB
Raw

Contributing to starhaven-io Projects

Thanks for taking the time to improve a Starhaven project. This organization default applies to repositories that do not have their own CONTRIBUTING.md. Repository-specific instructions in a README, AGENTS.md, or justfile take precedence.

Workflow

  • Create a branch and open a pull request. Do not push directly to main.
  • Use Conventional Commits for commit messages and PR titles, for example fix: handle missing package metadata.
  • Sign off commits with git commit -s for DCO.
  • Keep PR descriptions to a concise summary of the change. Do not add a standalone test-plan section or checklists.
  • When AI/LLM was used to generate or assist with a pull request, the initial PR description must end with exactly one unformatted line as the last line of the PR body: AI disclosure: <model> with <how the output was verified>. This is PR body text, not a commit trailer. Omit the line when no AI/LLM was used.
  • Name the model as its vendor names it, for example Claude Opus 5. Do not also name a tool or harness unless the harness is the only identifier. Do not describe what the AI did.
  • Do not format the disclosure as a heading, bullet, bold label, or horizontal rule, and do not add a promotional "generated with" footer.

Local Checks

  • Run just check before opening a PR when the repository has a justfile.
  • Run any targeted build, test, lint, format, audit, or link-check commands named in the repository README or AGENTS.md.
  • For docs-only changes, run the repository link checker when one exists, usually just lychee.

Security Reports

Do not report suspected vulnerabilities in public issues or discussions. Follow the inherited security policy or the affected repository's own security policy when one exists.