Skip to content

Add contribution guidelines - #10

Merged
aderaaij merged 1 commit into
mainfrom
docs/contributing
Nov 11, 2026
Merged

aderaaij merged 1 commit into
mainfrom
docs/contributing

Conversation

@aderaaij

Copy link
Copy Markdown
Owner

Adds a short CONTRIBUTING.md now that the first outside pull requests have come in, and links it from the README's Development section.

It covers when to open an issue first, how to run the three CI checks locally, the project conventions that are easy to trip over (metric API, the iOS app as the other half of the wire contract, per-resource JSON casing, defaults that leave existing installs unchanged, lockfiles), and how to add a changelog entry.

Docs only; no code changes.

@aderaaij
aderaaij merged commit 8619ca2 into main Nov 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant