mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-08 23:03:55 -05:00
Add per-project All Contributors setup
Set up separate contributor tracking for each sub-project: - book/.all-contributorsrc - Book content contributors - kits/.all-contributorsrc - Hardware kit contributors - labs/.all-contributorsrc - Lab exercise contributors - tinytorch/.all-contributorsrc - Framework contributors Each project now has: - Its own .all-contributorsrc config file - Contributors section in README with All Contributors format - Project-specific contribution types in the recognition guide - Cheatsheet in CONTRIBUTING.md (where applicable) Added @AmirAlasady as first TinyTorch contributor for bug report #1122. Usage: Comment on any issue/PR with: @all-contributors please add @username for bug, code, doc, or ideas
This commit is contained in:
Vijay Janapa Reddi
14
book/.all-contributorsrc
Normal file
14
book/.all-contributorsrc
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"projectName": "MLSysBook - Textbook",
|
||||
"projectOwner": "harvard-edge",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"files": ["README.md"],
|
||||
"imageSize": 80,
|
||||
"commit": false,
|
||||
"commitConvention": "angular",
|
||||
"contributorsPerLine": 7,
|
||||
"linkToUsage": false,
|
||||
"skipCi": true,
|
||||
"contributors": []
|
||||
}
|
||||
@@ -156,6 +156,26 @@ We welcome contributions! See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for g
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
|
||||
Thanks to these wonderful people who helped improve the book ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
**Recognize a contributor:** Comment on any issue or PR:
|
||||
```
|
||||
@all-contributors please add @username for doc, review, translation, or design
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Book content is licensed under **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International** (CC BY-NC-SA 4.0).
|
||||
|
||||
@@ -88,3 +88,32 @@ Opening an early PR is encouraged. This will allow us to provide feedback on you
|
||||
|
||||
For a more detailed guide on the CS249r documentation process and peer review,
|
||||
check [here](https://docs.google.com/document/d/1izDoWwFLnV8XK2FYCl23_9KYL_7EQ5OWLo-PCNUGle0).
|
||||
|
||||
## Contributor Recognition
|
||||
|
||||
We use [All Contributors](https://allcontributors.org) to recognize everyone who helps improve the book.
|
||||
|
||||
### How to Recognize a Contributor
|
||||
|
||||
After merging a PR or resolving an issue, comment:
|
||||
|
||||
```
|
||||
@all-contributors please add @username for TYPE
|
||||
```
|
||||
|
||||
### Contribution Types
|
||||
|
||||
| Type | Emoji | Use For |
|
||||
|------|-------|---------|
|
||||
| `doc` | 📖 | Wrote or improved content |
|
||||
| `review` | 👀 | Reviewed chapters or PRs |
|
||||
| `translation` | 🌍 | Translated content |
|
||||
| `design` | 🎨 | Created diagrams or figures |
|
||||
| `bug` | 🐛 | Found errors or typos |
|
||||
| `ideas` | 💡 | Suggested improvements |
|
||||
|
||||
### Example
|
||||
|
||||
```
|
||||
@all-contributors please add @contributor for doc, review
|
||||
```
|
||||
|
||||
14
kits/.all-contributorsrc
Normal file
14
kits/.all-contributorsrc
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"projectName": "MLSysBook - Hardware Kits",
|
||||
"projectOwner": "harvard-edge",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"files": ["README.md"],
|
||||
"imageSize": 80,
|
||||
"commit": false,
|
||||
"commitConvention": "angular",
|
||||
"contributorsPerLine": 7,
|
||||
"linkToUsage": false,
|
||||
"skipCi": true,
|
||||
"contributors": []
|
||||
}
|
||||
@@ -132,6 +132,26 @@ We welcome contributions to the hardware labs! To contribute:
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
|
||||
Thanks to these wonderful people who helped improve the hardware kits ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
**Recognize a contributor:** Comment on any issue or PR:
|
||||
```
|
||||
@all-contributors please add @username for tool, test, video, or doc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Authors
|
||||
|
||||
- **Marcelo Rovai** - Primary author
|
||||
|
||||
14
labs/.all-contributorsrc
Normal file
14
labs/.all-contributorsrc
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"projectName": "MLSysBook - Labs",
|
||||
"projectOwner": "harvard-edge",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"files": ["README.md"],
|
||||
"imageSize": 80,
|
||||
"commit": false,
|
||||
"commitConvention": "angular",
|
||||
"contributorsPerLine": 7,
|
||||
"linkToUsage": false,
|
||||
"skipCi": true,
|
||||
"contributors": []
|
||||
}
|
||||
@@ -67,6 +67,26 @@ Labs are under active development. To be notified when they launch:
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
|
||||
Thanks to these wonderful people who helped build the labs ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
**Recognize a contributor:** Comment on any issue or PR:
|
||||
```
|
||||
@all-contributors please add @username for code, tutorial, test, or doc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**Read. Explore. Build.** *(Labs coming soon)*
|
||||
|
||||
22
tinytorch/.all-contributorsrc
Normal file
22
tinytorch/.all-contributorsrc
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"projectName": "MLSysBook - TinyTorch",
|
||||
"projectOwner": "harvard-edge",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"files": ["README.md"],
|
||||
"imageSize": 80,
|
||||
"commit": false,
|
||||
"commitConvention": "angular",
|
||||
"contributorsPerLine": 7,
|
||||
"linkToUsage": false,
|
||||
"skipCi": true,
|
||||
"contributors": [
|
||||
{
|
||||
"login": "AmirAlasady",
|
||||
"name": "Amir Alasady",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/AmirAlasady",
|
||||
"profile": "https://github.com/AmirAlasady",
|
||||
"contributions": ["bug"]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -268,6 +268,38 @@ Your commits will be included in the next release with appropriate version bump.
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Contributor Recognition
|
||||
|
||||
We use [All Contributors](https://allcontributors.org) to recognize everyone who helps improve TinyTorch.
|
||||
|
||||
### How to Recognize a Contributor
|
||||
|
||||
After merging a PR or resolving an issue, comment:
|
||||
|
||||
```
|
||||
@all-contributors please add @username for TYPE
|
||||
```
|
||||
|
||||
### Contribution Types
|
||||
|
||||
| Type | Emoji | Use For |
|
||||
|------|-------|---------|
|
||||
| `bug` | 🐛 | Found a bug or issue |
|
||||
| `code` | 💻 | Submitted code |
|
||||
| `doc` | 📖 | Improved documentation |
|
||||
| `ideas` | 💡 | Suggested improvements |
|
||||
| `test` | 🧪 | Added tests |
|
||||
| `review` | 👀 | Reviewed PRs |
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@all-contributors please add @AmirAlasady for bug
|
||||
@all-contributors please add @student123 for code, doc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Remember**: TinyTorch is about teaching students to understand ML systems by building them. Every contribution should enhance that educational mission! 🎓🔥
|
||||
|
||||
**Questions?** Check the docs or open a GitHub Discussion.
|
||||
|
||||
@@ -255,12 +255,37 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
|
||||
Thanks to these wonderful people who helped improve TinyTorch ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AmirAlasady"><img src="https://avatars.githubusercontent.com/AmirAlasady?v=4?s=80" width="80px;" alt="Amir Alasady"/><br /><sub><b>Amir Alasady</b></sub></a><br /><a href="https://github.com/harvard-edge/cs249r_book/issues?q=author%3AAmirAlasady" title="Bug reports">🐛</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
**Recognize a contributor:** Comment on any issue or PR:
|
||||
```
|
||||
@all-contributors please add @username for bug, code, doc, or ideas
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Created by [Prof. Vijay Janapa Reddi](https://vijay.seas.harvard.edu) at Harvard University.
|
||||
|
||||
Special thanks to students and contributors who helped build this framework.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user