[GH-ISSUE #1173] Fix contribution guidelines in tinytorch package #35183

Closed
opened 2026-07-15 22:31:39 -05:00 by GiteaMirror · 2 comments
Owner

Originally created by @harishb00 on GitHub (Feb 14, 2026).
Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/1173

The tinytorch/CONTRIBUTING.md file contains inconsistencies and missing references. These may confuse new contributors.

Issues Identified

1. Incorrect folder reference

  • Commands only work after navigating (cd) into the cloned folder.
  • The package name should be tinytorch (currently written as TinyTorch).
  • Screenshot:
    Image

2. Missing or incorrect file references

  • CLAUDE.md is referenced ~5 times but does not exist. From the descriptions I can understand that contributor should follow this file for development guidelines. So sounds critical.
  • docs/development is only available under book/docs, and appears unrelated to tinytorch. If confirmed, this reference should be removed or replaced.
  • docs/INSTRUCTOR_GUIDE.md is missing in book/docs as well. However, tinytorch/INSTRUCTOR.md exists and may be the intended file. The reference should be updated accordingly.
  • Screenshot:
    Image

It is mentioned in the following line
https://github.com/harvard-edge/cs249r_book/blob/af2214eede72cb010d83c59773cb9ab049c8df85/tinytorch/CONTRIBUTING.md?plain=1#L141 that developers should make contribution to *_dev.py files. I couldn't find *_dev.py under the src folder. Is it a mistake? Can I directly contribute to module.py files.

Originally created by @harishb00 on GitHub (Feb 14, 2026). Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/1173 The [tinytorch/CONTRIBUTING.md](https://github.com/harvard-edge/cs249r_book/blob/af2214eede72cb010d83c59773cb9ab049c8df85/tinytorch/CONTRIBUTING.md) file contains inconsistencies and missing references. These may confuse new contributors. ## Issues Identified #### 1. Incorrect folder reference - Commands only work after navigating (cd) into the cloned folder. - The package name should be tinytorch (currently written as TinyTorch). - Screenshot: <img width="1397" height="453" alt="Image" src="https://github.com/user-attachments/assets/794a0e0a-3509-485b-9292-574c84ac8562" /> #### 2. Missing or incorrect file references - `CLAUDE.md` is referenced ~5 times but does not exist. From the descriptions I can understand that contributor should follow this file for development guidelines. So sounds critical. - `docs/development` is only available under `book/docs`, and appears unrelated to `tinytorch`. If confirmed, this reference should be removed or replaced. - `docs/INSTRUCTOR_GUIDE.md` is missing in `book/docs` as well. However, `tinytorch/INSTRUCTOR.md` exists and may be the intended file. The reference should be updated accordingly. - Screenshot: <img width="638" height="217" alt="Image" src="https://github.com/user-attachments/assets/fd65f8ca-641e-46b1-a64d-ffbfe4580d6c" /> It is mentioned in the following line https://github.com/harvard-edge/cs249r_book/blob/af2214eede72cb010d83c59773cb9ab049c8df85/tinytorch/CONTRIBUTING.md?plain=1#L141 that developers should make contribution to `*_dev.py` files. I couldn't find `*_dev.py` under the `src` folder. Is it a mistake? Can I directly contribute to `module.py` files.
GiteaMirror added the type: bugarea: tinytorch labels 2026-07-15 22:31:39 -05:00
Author
Owner

@profvjreddi commented on GitHub (Feb 14, 2026):

Hi @harishb00! 👋 Thank you for the thorough review of CONTRIBUTING.md. All the issues you identified have been cleaned up in commit f652692.

To answer your question, yes, contributors should edit the src/NN_name/NN_name.py files directly. Those are the source of truth. Thank you again for taking the time to report this 🙏

@all-contributors please add @harishb00 as a contributor for ✍️ Doc in TinyTorch

<!-- gh-comment-id:3902027846 --> @profvjreddi commented on GitHub (Feb 14, 2026): Hi @harishb00! 👋 Thank you for the thorough review of CONTRIBUTING.md. All the issues you identified have been cleaned up in commit [f652692](https://github.com/harvard-edge/cs249r_book/commit/f652692f5). To answer your question, yes, contributors should edit the src/NN_name/NN_name.py files directly. Those are the source of truth. Thank you again for taking the time to report this 🙏 @all-contributors please add @harishb00 as a contributor for ✍️ Doc in TinyTorch
Author
Owner

@github-actions[bot] commented on GitHub (Feb 14, 2026):

I've added @harishb00a as a contributor to tinytorch! 🎉

Recognized for: doc
Project: tinytorch (explicitly mentioned in comment)
Based on: @all-contributors please add @harishb00 as a contributor for ✍️ Doc in TinyTorch

The contributor list has been updated in:

  • tinytorch/.all-contributorsrc
  • tinytorch/README.md
  • Main README.md

We love recognizing our contributors! ❤️

<!-- gh-comment-id:3902030828 --> @github-actions[bot] commented on GitHub (Feb 14, 2026): I've added @harishb00a as a contributor to **tinytorch**! :tada: **Recognized for:** doc **Project:** tinytorch (explicitly mentioned in comment) **Based on:** @all-contributors please add @harishb00 as a contributor for ✍️ Doc in TinyTorch The contributor list has been updated in: - `tinytorch/.all-contributorsrc` - `tinytorch/README.md` - Main `README.md` We love recognizing our contributors! :heart:
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#35183