Skip to content

Commit ca69c7d

Browse files
malysclaude
andcommitted
docs: add contributing-efficiently, ways-to-help, and sponsorship sections
Documents that limited Claude Code quota is best spent on a finished PR rather than a feature request, adds a ways-to-help list (bug reports, docs, testing pre-releases), and points to GitHub Sponsors. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent a5cb662 commit ca69c7d

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Funding platforms for this repository.
2+
# Renders the "Sponsor" button on GitHub once the account has GitHub Sponsors enabled.
3+
github: [malys]

‎CONTRIBUTING.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,43 @@ is imposed rather than following the system: the screen faces the driver at nigh
6464
light background filling the windscreen is glare, not a preference. Keep new surfaces on
6565
the tokens instead of hard-coded colours or dimensions.
6666

67+
## Ways to help
68+
69+
Not every useful contribution is code:
70+
71+
- **Bug reports** — firmware generation, app version, what you did, what happened.
72+
- **Feature requests** — describe the problem before the solution.
73+
- **Documentation** — README, this guide, translations.
74+
- **Pull requests** — see below.
75+
- **Testing pre-releases** — install an `unstable` build and report what broke.
76+
- **Sponsorship** — see below.
77+
78+
## Contributing efficiently
79+
80+
Maintainer time and AI quota are the scarce resources here, ideas are not. If you have
81+
access to Claude Opus or another capable coding model, a finished pull request is worth
82+
much more than a feature request: someone still has to design, write, test and verify the
83+
request, and that someone has a limited quota too.
84+
85+
A pull request that lands quickly usually carries:
86+
87+
- The problem, in one or two sentences.
88+
- The proposed solution, and what you rejected.
89+
- The implementation, scoped to one concern.
90+
- Tests — `mise run check` passes.
91+
- Documentation updated: README, CHANGELOG, this guide where relevant.
92+
93+
Generate the change locally with whatever model you have, then read every line yourself
94+
before opening the PR. You are the author, not the model. Unreviewed generated code on a
95+
path that reaches the vehicle will be sent back.
96+
97+
## Sponsorship
98+
99+
Maintaining EVSuite costs development time, test hardware and AI usage. If it is useful in
100+
your daily driving, consider sponsoring through
101+
[GitHub Sponsors](https://github.com/sponsors/malys). Sponsorship covers those costs and
102+
gets fixes and features out faster.
103+
67104
## Language and licence
68105

69106
English by default — code, comments, commit messages, docs. Read

0 commit comments

Comments
 (0)