How dhakalnirajan/b.it-gandaki-university works
Main Components
• Top-Level Management: The root of the repository includes meta files (README.md, LICENSE, CONTRIBUTING.md, and GitHub configuration in the .github folder). These components serve as entry points for users and maintainers.
• Year-Level Organization: There are major folders by academic year (First Year, Second Year, Third Year) that encapsulate the curriculum and learning materials.
• Semester/Section Level: Within each year, further breakdowns exist – for example, within the “First Year” folder you find “First Semester” and “Second Semester” folders. This identifies a clear subdivision by the academic timeline.
• Subject and Course Level Components: Within each semester, individual course folders (e.g., Basics of IT, Mathematics I, Programming With C, Digital Logic, etc. in First Semester) symbolize the subjects. Some subjects have their own subdirectories (e.g., “Lab” folders, “Class Programs,” “Lecture Slides”) and additional resources (like PDFs, PPTX files, DOCX files, etc.).
• Auxiliary Components: Folders like .github (with workflows for automated tasks), Images (for logos and media), and configuration files support repository management and presentation.
Relationships and Interactions
• Hierarchical Dependency: The design should reflect a clear parent–child structure beginning with the repository root, followed by academic years, then semesters, and then subjects/resources.
• Grouped Resources: Within subjects, groupings may separate lecture materials from lab exercises, code samples, and assignment submissions. These can be visualized as subcomponents or clusters.
• Integration Points: Show integration with GitHub services (such as GitHub Actions configured via the .github/workflows folder), which provides continuous integration and may be used to automate validation, linting, or deployment of static content.
Architectural Patterns and Principles
• Modularity: Each folder (year, semester, subject) functions as an independent module so that updates or additions in one subject don’t affect others.
• Separation of Concerns: Distinct separation between academic content (subject folders) and repository management (meta files, GitHub workflows).
• Consistency: Consistent naming conventions and clear subdivisions aid in locating specific materials quickly.
Relevant Technologies and Elements
• Git and GitHub: Emphasize how the repository leverages Git for version control (with a dedicated .github directory for CI/CD).
• Licensing and Contribution: Mark the connection to licensing (LICENSE file) and contribution guidelines (CONTRIBUTING.md), which play an important role in open educational resources.