How ianuragmahapatra/itp-2025-group-06-hub works
Main Components
• Repository Core: At the center is the GitHub repository itself, which hosts the assignment instructions (in the Instructions folder and README); assignment PDFs (such as those in the week-1_assignment folder, including week-1_assignment.pdf); and submission code files (e.g., the C++ files in week-1_assignment/Remit).
• User/Student Environment: Represents the local cloning and forking process, where developers (students) clone their fork, add their assignment files (organized in personal folders inside week-specific directories), and eventually push commits.
• GitHub Infrastructure: This includes key elements like the forked repositories, Pull Request (PR) mechanism, and syncing with the upstream (main) repository.
• Mentor/Reviewer Process: A component (or a role) that reviews the submitted assignments through issues or PRs, as mentioned in the README, ensuring adherence to the coding standards.
Mapping Relationships and Interactions
• “Syncing Process”: Show a bidirectional interaction between the Student’s fork and the upstream repository to indicate the fetch/merge process.
• “Instruction & Guidelines”: The Instructions folder and README act as guiding documents for both the students and mentors – these can be shown as a supporting or reference component that informs each step of the process.
Architectural Patterns & Design Principles
• Modular Organization: The file structure is clearly modular – different weeks and inside those, a separation between assignment questions (in a subfolder like Remit) and PDFs containing assignment details. This modularity aids in scaling (i.e., additional weeks or groups) and maintaining clarity.
• Distributed Collaboration: The process of forking and making pull requests indicates a distributed workflow that leverages Git as a version control system. Represent this with components that highlight individual repositories (forks) merging into one central hub.
• Clear Separation of Roles: The architecture distinguishes between the student’s local development environment and the centralized hub (and further distinguishes the review/mentorship functions). This separation is key to ensuring the assignments are standardized and reviewed correctly.
Technologies and Practices to Highlight
• Git & GitHub: Emphasize the version control (git commands, fork, clone, pull request) as fundamental to the system design.
• File-Based Submission: The use of directories and code files (like .cpp and PDFs) should be labeled, showing how the content of the repository is organized.
Summary
• Branch off to show local student interactions: fork, clone, add assignment folder, commit, push, and PR creation.
• Side components such as the “Instructions” folder and “Flowchart” image (from the README) act as foundational documentation supporting every part of the process.
• Modular, week-wise structure by depicting folders like “week-1_assignment” and a subcomponent like “Remit” containing several assignment question files (in C++).