Contributing

We :heart: contributions! Whether it is a bug report, a new feature or an improvement to the documentation, your help makes the project better for everyone.

1 · Find something to work on

Browse the Issues tab and filter by the good first issue or documentation labels.
Join the discussion to avoid duplicate work.

If you are unsure, open a Draft PR early – reviewers can then give feedback as you iterate.

2 · Fork & create a branch


git checkout -b feat/my-awesome-thing

Use present-tense imperative commit messages – e.g. “Add solar panel power graph”.

3 · Run the checks locally


pnpm lint   # ESLint, TypeScript & MDX
pnpm test   # unit tests (if any)
pnpm build  # type errors & static site build

The CI pipeline runs the same commands – make them pass locally to save round-trips.

4 · Open the pull request

The PR template will ask you to confirm:

• The code builds.
• New docs include front-matter.
• Screenshots / GIFs for UI changes are attached.

Reviewers strive to respond within 48 hours. Feel free to ping after that.

5 · Celebrate 🎉

Your changes will land in main once approvals are in and checks are green. Thank you for investing your time!