diff --git a/book/.all-contributorsrc b/book/.all-contributorsrc new file mode 100644 index 000000000..45f638b2d --- /dev/null +++ b/book/.all-contributorsrc @@ -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": [] +} diff --git a/book/README.md b/book/README.md index 0b8a7ed4f..8d4d3c3bc 100644 --- a/book/README.md +++ b/book/README.md @@ -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)): + + + + + + + + + + +**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). diff --git a/book/docs/CONTRIBUTING.md b/book/docs/CONTRIBUTING.md index 8222a24a0..b843b78b5 100644 --- a/book/docs/CONTRIBUTING.md +++ b/book/docs/CONTRIBUTING.md @@ -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 +``` diff --git a/kits/.all-contributorsrc b/kits/.all-contributorsrc new file mode 100644 index 000000000..4d47483db --- /dev/null +++ b/kits/.all-contributorsrc @@ -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": [] +} diff --git a/kits/README.md b/kits/README.md index 5adb573d5..e013939a7 100644 --- a/kits/README.md +++ b/kits/README.md @@ -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)): + + + + + + + + + + +**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 diff --git a/labs/.all-contributorsrc b/labs/.all-contributorsrc new file mode 100644 index 000000000..f96500ff7 --- /dev/null +++ b/labs/.all-contributorsrc @@ -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": [] +} diff --git a/labs/README.md b/labs/README.md index bdba3d4f5..e1cef90f9 100644 --- a/labs/README.md +++ b/labs/README.md @@ -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)): + + + + + + + + + + +**Recognize a contributor:** Comment on any issue or PR: +``` +@all-contributors please add @username for code, tutorial, test, or doc +``` + +--- +
**Read. Explore. Build.** *(Labs coming soon)* diff --git a/tinytorch/.all-contributorsrc b/tinytorch/.all-contributorsrc new file mode 100644 index 000000000..55d0852c0 --- /dev/null +++ b/tinytorch/.all-contributorsrc @@ -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"] + } + ] +} diff --git a/tinytorch/CONTRIBUTING.md b/tinytorch/CONTRIBUTING.md index 95729eb65..78cb48cc9 100644 --- a/tinytorch/CONTRIBUTING.md +++ b/tinytorch/CONTRIBUTING.md @@ -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. diff --git a/tinytorch/README.md b/tinytorch/README.md index 6c4257e5e..eac2cc755 100644 --- a/tinytorch/README.md +++ b/tinytorch/README.md @@ -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)): + + + + + + + + + + +
Amir Alasady
Amir Alasady
๐Ÿ›
+ + + + + + +**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