Files
bambu-nfc/CONTRIBUTING.md
T
s1d3sw1ped_bot 07285ddd6d
CI / test (pull_request) Successful in 18s
CI / test (push) Successful in 18s
docs: Add CONTRIBUTING.md
Point new contributors at develop for PRs, kernel-style commit
subjects, What/Why/Test PR bodies, and safe issue citations under
Gitea merge-text closing rules.
2026-09-01 18:51:08 +00:00

973 B

Contributing

Pull requests

Prefer pull requests against develop. The repository default is master or main; develop exists for ongoing integration.

Commits

Subject form (kernel-style):

area: Imperative summary
  • Imperative mood after the colon (Add, Fix, Remove, …).
  • No trailing period on the subject. Aim for about 75 characters total.
  • Body states the problem and why the change is right.
  • One logical change per commit. Skip the body only when the subject alone is obvious to a reviewer.

Pull request description

  • What — what changed
  • Why — problem and impact
  • Test — concrete steps a reviewer can run

Do not leave the description as “see commits”.

Issues

Gitea closes issues when a bare issue reference appears in merge text. Cite leftover issues by full URL. Only close an issue when the merge actually finishes that work.

License

License: see LICENSE if present; otherwise TBD by owner.