Project requirements checklist - SagnikSaha01/CSC510-002-4 GitHub Wiki

✅ Project Requirements Checklist

Team & Collaboration

• Workload is reasonably spread across the team
• Number of commits is sufficient
• Commits are made by multiple different team members
• There are many meaningful issue reports
• Issues are being actively closed
• Issues are discussed before closing (include summary in issue)

Documentation

• Documentation is generated and formatted cleanly (not messy)
• Docs: What — Each class/function has clear, descriptive documentation
• Docs: How — Mini-tutorials showing how to perform common tasks (X, Y, Z)
• Docs: Why — Documentation explains motivation/purpose/story of the project
• Short animated/recorded video explaining why the project matters

Testing & Quality

• Test suite exists (dozens of tests, ~30%+ of codebase)
• Tests run automatically using CI (GitHub Actions, Travis, etc.)
• When tests fail, issues are created, discussed, and fixed
• All team members can access and use all tools & project resources
• Config files show shared tooling, edited by multiple members
• Anyone on the team can screen-share and run the system locally
• Team members contribute across multiple parts of the codebase
• Frequent commits and short release cycles (active iteration)

Repository Meta Files

• .gitignore exists and correctly excludes unnecessary files
• INSTALL.md explains how to build/run the project
• LICENSE.md exists
• CODE_OF_CONDUCT.md exists
• CONTRIBUTING.md exists
• README.md is complete, clear, and polished

Showcase

• 2-minute demo video showing significant new functionality

Badges (placed in README)

• DOI badge from Zenodo
• Code style checker badge
• Code formatter badge
• Syntax checker badge
• Code coverage badge
• Additional automated analysis tool badges (if applicable)