How niclabs/template-practicas works
Main “components”
• • Repository Configuration & Metadata:
• Files: .gitignore, .project_info, keywords.txt
• Purpose: Configure what to ignore, store project metadata and guidelines.
• • Documentation & Educational Material:
• Files: README.md, README_english.md, and the slides within slides-COM4602 (PDFs)
• Purpose: Provide instructions, best practices, educational content on Git workflows, issues, commits, branches, and Git hooks.
• • Implementation & Testing Code:
• Files: search_algorithm.py and testing.py
• Purpose: Offer sample code and associated tests. (Notice how the README even explains how to use these files with Git hooks to prevent bad commits.)
• • Git Hooks Setup:
• Although not physically a separate component in the file tree, the README details how to set up a pre-commit hook (located in the .git/hooks directory) that runs testing.py. This represents the automation (CI) integration that ensures quality before committing.
• From the “Repository Config” and “Documentation” components to “Code & Testing” to indicate that developers follow guidelines and metadata when working with the code.
• From “Git Hooks / Automation” to “Code & Testing” showing that the pre-commit hook triggers the testing phase before accepting changes.
Architectural Patterns & Design Principles
• • Modularity: The project clearly separates configuration (metadata and .gitignore), educational content (slides and README), and implementation (code and tests). Show these as separate modules and indicate they are loosely coupled.
Relevant Technologies & Practices
• Mention Python as the language used (for search_algorithm.py and testing.py).
• Practices (like commit atomicity, branch naming conventions, and use of Git hooks) as described in the README.