Skip to content

Commit 0b545a9

Browse files
authored
Merge pull request #1180 from waterWang/fix/contributors-docs
docs(CONTRIBUTING.md): add all-contributors badge usage documentation
2 parents bcc28d6 + 15a7b24 commit 0b545a9

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,47 @@ Be constructive.
472472

473473
---
474474

475+
476+
477+
---
478+
479+
# 🤝 Contributor Badges
480+
481+
This project uses the [all-contributors](https://github.com/all-contributors/all-contributors) specification to recognize contributors.
482+
483+
## Triggering the Bot
484+
485+
After your pull request is merged or closed, comment on the merged PR or issue:
486+
487+
```
488+
@all-contributors please add @<your-username> for code
489+
```
490+
491+
The bot will add your profile to the Contributors table in the root `README.md`.
492+
493+
## Adding Sub-Package READMEs
494+
495+
Currently, only the root `README.md` has a Contributors section. If you add a Contributors section to a sub-package README (e.g., `backend/README.md`, `frontend/README.md`, `contracts/README.md`), update `.all-contributorsrc` in the repo root to include the additional path:
496+
497+
```json
498+
"files": [
499+
"README.md",
500+
"backend/README.md"
501+
]
502+
```
503+
504+
## Available Contribution Types
505+
506+
- `code` — Code contributions
507+
- `doc` — Documentation
508+
- `design` — Design
509+
- `bug` — Bug reports
510+
- `review` — Pull Request reviews
511+
- `test` — Testing
512+
- `infra` — Infrastructure / DevOps
513+
- `ideas` — Ideas & planning
514+
515+
475516
# Final Notes
476517

477518
- Contributions of all sizes are welcome

0 commit comments

Comments
 (0)