Skip to content

Commit a679fe9

Browse files
Paul Mulliganclaude
andcommitted
feat: add all-contributors recognition system
Adopt the All Contributors specification so every kind of contribution is recognized - code, docs, tests, bug reports, ideas, reviews, and infrastructure work. - .all-contributorsrc configures the spec; angular commitConvention keeps bot commits compatible with commitlint, and skipCi false keeps CI running on bot PRs - README gains an all-contributors badge and a Contributors section seeded with the project maintainer - CONTRIBUTING documents the recognized contribution types and the @all-contributors bot comment workflow - Quote the commit-msg hook's file argument so commitlint works from linked worktrees and paths containing spaces The @all-contributors GitHub App must be installed once on the repo (https://github.com/apps/allcontributors) for the comment-driven workflow to operate. Closes #58 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 5a13523 commit a679fe9

4 files changed

Lines changed: 83 additions & 1 deletion

File tree

.all-contributorsrc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"projectName": "Nerva",
3+
"projectOwner": "PMDevSolutions",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": false,
11+
"commitConvention": "angular",
12+
"contributorsPerLine": 7,
13+
"linkToUsage": false,
14+
"skipCi": false,
15+
"contributors": [
16+
{
17+
"login": "PAMulligan",
18+
"name": "PMullz",
19+
"avatar_url": "https://avatars.githubusercontent.com/u/13412531?v=4",
20+
"profile": "https://pmds.info/",
21+
"contributions": [
22+
"code",
23+
"doc",
24+
"test",
25+
"infra",
26+
"review",
27+
"ideas"
28+
]
29+
}
30+
]
31+
}

.husky/commit-msg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
npx --no -- commitlint --edit ${1}
1+
npx --no -- commitlint --edit "${1}"

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,34 @@ Community members are encouraged to vote on priorities and propose new ideas via
158158

159159
---
160160

161+
## Contributor Recognition
162+
163+
Nerva follows the [All Contributors](https://allcontributors.org) specification: every kind of contribution counts, not just code. Recognized contributors appear in the [contributors table](README.md#contributors) in the README.
164+
165+
The contribution types most relevant to Nerva:
166+
167+
| Type | Emoji | Covers |
168+
|------|-------|--------|
169+
| `code` | 💻 | Code contributions |
170+
| `doc` | 📖 | Documentation |
171+
| `test` | ⚠️ | Tests |
172+
| `bug` | 🐛 | Bug reports |
173+
| `ideas` | 🤔 | Ideas and suggestions |
174+
| `review` | 👀 | Code review |
175+
| `infra` | 🚇 | Infrastructure (CI/CD, deployment) |
176+
177+
Other [emoji key](https://allcontributors.org/en/reference/emoji-key/) types count as well.
178+
179+
**How recognition works:** once your contribution lands, a maintainer comments on the related issue or pull request:
180+
181+
```text
182+
@all-contributors please add @<your-username> for code, doc
183+
```
184+
185+
The [@all-contributors bot](https://allcontributors.org/en/bot/usage/) then opens a pull request adding you to the README table and `.all-contributorsrc`. If your contribution was overlooked, mention it on your PR or open an issue — recognition requests are always welcome.
186+
187+
---
188+
161189
## Code of Conduct
162190

163191
This project follows the [Contributor Covenant v2.1](CODE_OF_CONDUCT.md). All contributors are expected to:

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A Claude Code-integrated API & backend development framework with TypeScript, Ho
77
[![CI](https://github.com/PMDevSolutions/Nerva/actions/workflows/ci.yml/badge.svg)](https://github.com/PMDevSolutions/Nerva/actions/workflows/ci.yml)
88
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
99
[![Patreon](https://img.shields.io/badge/Patreon-Support-orange?logo=patreon)](https://www.patreon.com/PaulMakesThings)
10+
[![All Contributors](https://img.shields.io/github/all-contributors/PMDevSolutions/Nerva?color=ee8449&style=flat-square)](#contributors)
1011

1112
---
1213

@@ -207,6 +208,28 @@ Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md)
207208

208209
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
209210

211+
## Contributors
212+
213+
Thanks to these wonderful people ([emoji key](https://allcontributors.org/en/reference/emoji-key/)):
214+
215+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
216+
<!-- prettier-ignore-start -->
217+
<!-- markdownlint-disable -->
218+
<table>
219+
<tbody>
220+
<tr>
221+
<td align="center" valign="top" width="14.28%"><a href="https://pmds.info/"><img src="https://avatars.githubusercontent.com/u/13412531?v=4?s=100" width="100px;" alt="PMullz"/><br /><sub><b>PMullz</b></sub></a><br /><a href="https://github.com/PMDevSolutions/Nerva/commits?author=PAMulligan" title="Code">💻</a> <a href="https://github.com/PMDevSolutions/Nerva/commits?author=PAMulligan" title="Documentation">📖</a> <a href="https://github.com/PMDevSolutions/Nerva/commits?author=PAMulligan" title="Tests">⚠️</a> <a href="#infra-PAMulligan" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/PMDevSolutions/Nerva/pulls?q=is%3Apr+reviewed-by%3APAMulligan" title="Reviewed Pull Requests">👀</a> <a href="#ideas-PAMulligan" title="Ideas, Planning, & Feedback">🤔</a></td>
222+
</tr>
223+
</tbody>
224+
</table>
225+
226+
<!-- markdownlint-restore -->
227+
<!-- prettier-ignore-end -->
228+
229+
<!-- ALL-CONTRIBUTORS-LIST:END -->
230+
231+
This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome — see [how contributors are recognized](CONTRIBUTING.md#contributor-recognition).
232+
210233
## Support the Project
211234

212235
Nerva is free and open source. If you find it useful, consider supporting development on [Patreon](https://www.patreon.com/PaulMakesThings). Supporters get voting power on the development roadmap.

0 commit comments

Comments
 (0)