alunduil CONTRIBUTING
Reference: https://github.com/nayafia/contributing-template (CC0).
Is one warranted?
- Open source, accepting contributions: yes — fill in nayafia.
- Closed source / personal config / archived: no — a one-line note in the README suffices. Don't manufacture process for a project that won't use it.
- Library or tool with even occasional outside contributors: yes, even if minimal.
If not warranted, say so and stop.
Template (fill what applies, drop the rest)
- Welcome / how to contribute — issues, PRs, docs, design. Be concrete about what's wanted.
- Ground rules — code of conduct pointer, scope boundaries, what won't be accepted.
- Your first contribution — "good first issue" filter or a small task.
- Getting started — clone, prerequisites, dev loop (sensors: tests, linters, type checks). Mirror the README's install but for the contributor path.
- Reporting bugs / suggesting features — issue templates if any; otherwise required fields.
- Code review process — who reviews, turnaround, draft-PR convention if used.
- Commit / PR conventions — message style, branch naming, sign-off, PR template.
- Community — chat, mailing list — only when they exist.
Concise, friendly, action-oriented. Drop sections rather than pad.
Procedure
- Decide warranted vs. not.
- If warranted: read existing CONTRIBUTING (if any), README, and 1-2 recent PRs to learn the actual process. Don't invent process the project doesn't use.
- Surface scope and any inferences before drafting. Apply only after agreement.