proj1rubric

Sum = 219/270 <br clear=all>

Notes	Self Assessment zero (none), one (a litte), two (somewhat), three (a lot)	Evidence
workload is spread over the whole team (one team member is often Xtimes more productive than the others...	3	Evidence in Road Map
but nevertheless, here is a track record that everyone is contributing a lot)	3	Evidence in Road Map
Number of commits	3	Evidence in Github
Number of commits: by different people	3	Evidence in Github
Issues reports: there are many	3	Evidence in Road Map
Issues are being closed	3	Evidence in Road Map
DOI badge: exists	3	Evidence in Github
Docs: doco generated , format not ugly	3	Evidence in Docs
Docs: what: point descriptions of each class/function (in isolation)	3	Evidence in [Software Document] (https://github.com/anshulp2912/scrivener/blob/main/docs/Project%20Documentation.pdf)
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z	3	Evidence in Software Document
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	Evidence in Software Document
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.	3	Evidence in Youtube
Use of version control tools	3	Evidence in Requirements
Use of style checkers	0
Use of code formatters.	0
Use of syntax checkers	0
Use of code coverage	3	Evidence
other automated analysis tools	0
test cases exist	3	Evidence in Test
test cases are routinely executed	3	Test cases are manually executed before every commit
the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up	3	Evidence in Contributing
issues are discussed before they are closed	3	Discussed on Discord Channel
Chat channel: exists	3	Evidence in Discord
test cases:.a large proportion of the issues related to handling failing cases.	3	Each test case handles the failing tests itself
evidence that the whole team is using the same tools: everyone can get to all tools and files	3	Evidence in Requirements
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 in Requirements
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 base	3	Evidence in Commit
short release cycles	3	Evidence in Commit
Software: Does your website and documentation provide a clear, high-level overview of your software?	3	In Documentation
Software: Does your website and documentation clearly describe the type of user who should use your software?	2	Documentation does, website does not
Software: Do you publish case studies to show how your software has been used by yourself and others?	0
Project's and software's identity: Is the name of your project/software unique?	3
Project's and software's identity: Is your project/software name free from trademark violations?	3
Availability of your software: Is your software available as a package that can be deployed without building it?	3	website
Availability of your software:Is your software available for free?	3
Availability of your software: Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository?	3
Availability of your software: Is your software hosted in an established, third-party repository likeGitHub (https://github.com), BitBucket (https://bitbucket.org),LaunchPad (https://launchpad.net) orSourceForge (https://sourceforge.net)?	3
software's documentation: Is your documentation clearly available on your website or within your software?	3
software's documentation: Does your documentation include a "quick start" guide, that provides a short overview of how to use your software with some basic examples of use?	3	Readme
software's documentation: If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?	3
software's documentation: Do you provide a comprehensive guide to all your software’s commands, functions and options?	3	Check Evidence in [Software Document]
software's documentation: Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages?	0
software's documentation: Do you store your documentation under revision control with your source code?	3
software's documentation: Do you publish your release history e.g. release data, version numbers, key features of each release etc. on your web site or in your documentation?	0	Not applicable
Support your software: Does your software describe how a user can get help with using your software?	3
Support your software: Does your website and documentation describe what support, if any, you provide to users and developers?	3	Evidence in Contributing
Support your software: Does your project have an e-mail address or forum that is solely for supporting users?	3
Support your software: Are e-mails to your support e-mail address received by more than one person?	0
software's maintainability: Is your software’s architecture and design modular?	3
software's maintainability: Does your software use an accepted coding standard or convention?	3
Open standards and your software: Does your software allow data to be imported and exported using open data formats?	3
Open standards and your software: Does your software allow communications using open communications protocols?	3	It can run on localhost
Software's portability: Is your software cross-platform compatible?	3
Software and accessibility: Does your software adhere to appropriate accessibility conventions or standards?	3
Software and accessibility: Does your documentation adhere to appropriate accessibility conventions or standards?	3	Yes it is accessible to anyone
Manage source code: Is your source code stored in a repository under revision control?	3
Manage source code: Are releases tagged in the repository?	0	Not applicable
Manage source code:Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully)	2	main
Manage source code:Do you back-up your repository?	3
Building and installing your software: Do you provide publicly-available instructions for building your software from the source code?	3
Building and installing your software: Do you provide publicly-available instructions for deploying your software?	3
Building and installing your software:Does your documentation list all third-party dependencies?	3
Building and installing your software:Does your documentation list the version number for all third-party dependencies?	3
Building and installing your software: Do you have tests that can be run after your software has been built or deployed to show whether the build or deployment has been successful?	3	Evidence in Test
Test your software: Do you have an automated test suite for your software?	0
Test your software: Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?	2	Manual tests
Test your software: Do you use continuous integration, automatically running tests whenever changes are made to your source code?	0
Test your software: Are your test results publicly visible?	3
Test your software: Are all manually-run tests documented?	3	Check Evidence in [Software Document]
Engage with your community: Does your website state how many projects and users are associated with your project?	2	Github-Yes, Website- No
Engage with your community: Do you provide success stories on your website?	0
Engage with your community: Do you list your important partners and collaborators on your website?	0
Engage with your community: Do you list your project's publications on your website or link to a resource where these are available?	3	Evidence in Readme
Engage with your community: Do you list third-party publications that refer to your software on your website or link to a resource where these are available?	3
Engage with your community: Can users subscribe to notifications to changes to your source code repository?	2	Added to Roadmap
Engage with your community: If your software is developed as an open source project (and, not just a project developing open source software), do you have a governance model?	0
Manage contributions: Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project?	3	Evidence in Contributing
Manage contributions: Do you have a contributions policy?	3	Evidence in Contributing
Manage contributions: Is your contributions' policy publicly available?	3	Evidence in Contributing
Manage contributions: Do contributors keep the copyright/IP of their contributions?	3	Evidence in License
Software's copyright and licensing: Does your website and documentation clearly state the copyright owners of your software and documentation?	3	Evidence in License
Software's copyright and licensing: Does each of your source code files include a copyright statement?	3
Software's copyright and licensing: Does your website and documentation clearly state the licence of your software?	2	Yes for documentation, No- Website
Software's copyright and licensing: Is your software released under an open source licence?	3	Evidence in License
Software's copyright and licensing: Is your software released under an OSI-approved open-source licence?	3	Evidence in License
Software's copyright and licensing: Does each of your source code files include a licence header?	3
Software's copyright and licensing: Do you have a recommended citation for your software?	3	Evidence in Citation
Plans for the future: Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?	3	Evidence in Road Map
Plans for the future: Do you make timely announcements of the deprecation of components, APIs, etc.?	0	Not applicable

Related Documents

AI Tools for Developers

Lesson 01: Evaluation Frameworks Overview

Voice AI Leaderboards, Benchmarks, and Evaluation Gaps (Jan 2025 -- Feb 2026)

Evaluating AI Agent Systems: Metrics, Benchmarks, and Quality Assurance (2024-2026)