proj2rubric

Total Score:

Notes	Score	Evidence
Video1	3	V2 LiveDemo
Bonus: Xfold improvement	3	Scalability
Docs: what: point descriptions of each class/function (in isolation)	3	Pdoc Generated GitHub
Use of style checkers	3	Code Linting Integrated GitHub Action
Use of code formatters.	3	Code Linting Integrated GitHub Action
Use of syntax checkers.	3	Code Linting Integrated GitHub Action
Use of code coverage	3	Badge in README.md
Other automated analysis tools	3	Evidence
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	3	From GH Insights, team members have equally participated in scaling the original project
Number of commits	3	From Github commits
Number of commits: by different people	3	From GH Insights
Issues reports: there are many	3	Overall 10+ issues listed
Issues are being closed	3	At the time of submission, all issues have sparked discussions with teammates and have been closed.
DOI badge: exists	3	From GH within README.md
Docs: doco generated, format not ugly	3	Evidence
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z	3	LiveDemo
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing	3	"Generate documents with Python and get the job done faster than ever before! With Python document generator, you can create professional-looking documents in no time, so you can focus on the important things. Get ready to revolutionize your workflow - it's time to take your productivity to the next level!"
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.	3	Readme
Use of version control tools	3	Git utilized
Test cases exist	3	Evidence
Test cases are routinely executed	3	Evidence
The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up	3	Contribution information is up to date. Links are included within the file to point to additional resources or areas on the git page that should be used when contributing.
Issues are discussed before they are closed	3	Evidence
Chat channel: exists	3	Chat channel is available and is activly used. Evidence
Test cases: a large proportion of the issues related to handling failing cases.	3	GH Action
Evidence that the whole team is using the same tools: everyone can get to all tools and files	3	All members contributing across branches. Development/testing has occured on multiple machines.
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
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	The entire team has access to the repository and is able to run the demo. We ensured this by having different members screen share and run the program during troubleshooting sessions.
Evidence that the members of the team are working across multiple places in the code base	3	All team members worked on the front and the backend
Short release cycles	3	Evident from multiple commits.

Related Documents

Judging Rubric

Multi-Framework Scoring Rubric

Introduction

📑 Project Index - Quick Navigation