Back to .md Directory

proj2rubric

|Notes|Assessment (Total : 87 )|Evidence|

May 2, 2026
0 downloads
0 views
ai rag
View source
NotesAssessment (Total : 87 )Evidence
Video13A video showing the functionality of the previous project is included in README.md
Video23A vidoe of the updated and scaled app with the new functionalities is included in README.md
Bonus: Xfold improvement3Highlighted in README.md
Docs: what: point descriptions of each class/function (in isolation)3Mentioned in respective README.md inside the respective folders
Use of style checkers3Pylint used
Use of code formatters.3Pylint used
Use of syntax checkers.3Pylint used
Use of code coverage3Coverage badge is present in README
Other automated analysis tools3Used github actions
Workload is spread over the whole team (one team member is often Xtimes more productive than the others... but nevertheless, here is a track record that everyone is contributing a lot)3Everyone has committed and contributed equally. Visible in Insights -> Contributors
Number of commits3There were a lot of commits Present in Insights -> Contributors
Number of commits: by different people3Everyone has committed in different areas. Visible in Insights -> Contributors
Issues reports: there are many3Issues were raised and resolved. Visible in Issues
Issues are being closed3A lot of issues were opened, resolved and closed Visible in Issues
DOI badge: exists3Visible in GitHub Repository
Docs: doco generated, format not ugly3Documentation is present with all the blings! GitHub Repository README.md
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z0No such examples or tutorials found
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing3Documentation includes the story, punchline and would motivate anyone to rush out and use the thing
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.3Animation video present in GitHub Repository README.md
Use of version control tools3GitHub was used by the team
Test cases exist3Test cases are present in tests folder. see here
Test cases are routinely executed3Test cases are executed
The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up3File is present and clear instructions are available
Issues are discussed before they are closed3Issues were discussed before closing
Chat channel: exists3Slack channel exists See here
Test cases: a large proportion of the issues related to handling failing cases.0No issues found
Evidence that the whole team is using the same tools: everyone can get to all tools and files3Everyone has contributed to different files
Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)3
Evidence that the whole team is using the same tools (e.g. tutor can ask anyone to share screen, they demonstrate the system running on their computer)3
Evidence that the members of the team are working across multiple places in the code base3Team members have been found contributing in different area
Short release cycles3Regular commits and releases have been made

Related Documents