HW5 Rubric Template

# HW5 Rubric Template

|<div style="width:256px">Notes</div>|Assessment|Evidence|
|--------|------|-------|
|Video1|||
|Video2|||
|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)|||
|Number of commits|||
|Number of commits: by different people|||
|Issues reports: there are many|||
|Issues are being closed|||
|DOI badge: exists|||
|Docs: doco generated, format not ugly|||
|Docs: what: point descriptions of each class/function (in isolation)|||
|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|||
|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want 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.|||
|Use of version control tools|||
|Use of  style checkers|||
|Use of code  formatters.|||
|Use of syntax checkers.|||
|Use of code coverage|||
|Other automated analysis tools|||
|Test cases exist|||
|Test cases are routinely executed|||
|The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up|||
|Issues are discussed before they are closed|||
|Chat channel: exists|||
|Test cases: a large proportion of the issues related to handling failing cases.|||
|Evidence that the whole team is using the same tools: everyone can get to all tools and files|||
|Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)|||
|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)|||
|Evidence that the members of the team are working across multiple places in the code base|||
|Short release cycles|||
|Does your website and documentation provide a clear, high-level overview of your software?|||
|Does your website and documentation clearly describe the type of user who should use your software?|||
|Do you publish case studies to show how your software has been used by yourself and others?|||
|Is the name of your project/software unique?|||
|Is your project/software name free from trademark violations?|||
|Is your software available as a package that can be deployed without building it?|||
|Is your software available for free?|||
|Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository?|||
|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)?|||
|Is your documentation clearly available on your website or within your software?|||
|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?|||
|If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?|||
|Do you provide a comprehensive guide to all your software’s commands, functions and options?|||
|Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages?|||
|If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation?|||
|Do you store your documentation under revision control with your source code?|||
|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?|||
|Does your software describe how a user can get help with using your software?|||
|Does your website and documentation describe what support, if any, you provide to users and developers?|||
|Does your project have an e-mail address or forum that is solely for supporting users?|||
|Are e-mails to your support e-mail address received by more than one person?||| 
|Does your project have a ticketing system to manage bug reports and feature requests?|||
|Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests?|||
|Is your software’s architecture and design modular?|||
|Does your software use an accepted coding standard or convention?|||
|Does your software allow data to be imported and exported using open data formats?|||
|Does your software allow communications using open communications protocols?|||
|Is your software cross-platform compatible?|||
|Does your software adhere to appropriate accessibility conventions or standards?|||
|Does your documentation adhere to appropriate accessibility conventions or standards?|||
|Is your source code stored in a repository under revision control?|||
|Is each source code release a snapshot of the repository?|||
|Are releases tagged in the repository?|||
|Is there a branch of the repository that is always stable?|||
|Do you back-up your repository?|||
|Do you provide publicly-available instructions for building your software from the source code?|||
|Can you build, or package, your software using an automated tool?|||
|Do you provide publicly-available instructions for deploying your software?|||
|Does your documentation list all third-party dependencies?|||
|Does your documentation list the version number for all third-party dependencies?|||
|Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?|||
|Can you download dependencies using a dependency management tool or package manager?|||
|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?|||
|Do you have an automated test suite for your software?|||
|Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|||
|Do you use continuous integration, automatically running tests whenever changes are made to your source code?|||
|Are your test results publicly visible?|||
|Are all manually-run tests documented?|||
|Does your project have resources (e.g. blog, Twitter, RSS feed, Facebook page, wiki, mailing list) that are regularly updated with information about your software?|||
|Does your website state how many projects and users are associated with your project?|||
|Do you provide success stories on your website?|||
|Do you list your important partners and collaborators on your website?|||
|Do you list your project's publications on your website or link to a resource where these are available?|||
|Do you list third-party publications that refer to your software on your website or link to a resource where these are available?|||
|Can users subscribe to notifications to changes to your source code repository?|||
|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?|||
|Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project?|||
|Do you have a contributions policy?|||
|Is your contributions' policy publicly available?|||
|Do contributors keep the copyright/IP of their contributions?|||
|Does your website and documentation clearly state the copyright owners of your software and documentation?|||
|Does each of your source code files include a copyright statement?|||
|Does your website and documentation clearly state the licence of your software?|||
|Is your software released under an open source licence?|||
|Is your software released under an OSI-approved open-source licence?|||
|Does each of your source code files include a licence header?|||
|Do you have a recommended citation for your software?|||
|Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?|||
|Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed?|||
|Do you make timely announcements of the deprecation of components, APIs, etc.?|||


## 1. https://github.com/sam16222/CSC510_43

|<div style="width:256px">Notes</div>|Assessment|Evidence|
|--------|------|-------|
|Video1|0|NA|
|Video2|0|NA|
|Workload is spread over the whole team (one team member is often Xtimes more productive than the others...|2| Spread evenly when commits are compared but slightly uneven with line count|
|but nevertheless, here is a track record that everyone is contributing a lot)|||
|Number of commits|3||
|Number of commits: by different people|3|sam16222 - 19 commits, kAsrita- 12 commits, VinitDesai98 - 18 commits, dearpriyankasa - 9 commits, kkajani - 6 commits, karan717 - 3 commits|
|Issues reports: there are many|3| 0 open & 4 closed|
|Issues are being closed|3|All issues are closed|
|DOI badge: exists|3|https://github.com/sam16222/CSC510_43|
|Docs: doco generated, format not ugly|0|No docs|
|Docs: what: point descriptions of each class/function (in isolation)|0|No docs|
|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|0|No Docs|
|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing|0|No Docs|
|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|0|N/A|
|Use of version control tools|3| Using Git|
|Use of  style checkers|0|Not present|
|Use of code  formatters.|0|Not present|
|Use of syntax checkers.|0|Not Present|
|Use of code coverage|3| Good code coverage 91%|
|Other automated analysis tools|0|N/A|
|Test cases exist|3|[Test](https://github.com/sam16222/CSC510_43/tree/main/tests)|
|Test cases are routinely executed|3|Present in above mentioned file|
|The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up|3|[CONTRIBUTING.md](https://github.com/sam16222/CSC510_43/blob/main/CONTRIBUTING.md)|
|Issues are discussed before they are closed|3|4 Isses closed|
|Chat channel: exists|0|N/A|
|Test cases: a large proportion of the issues related to handling failing cases.|3||
|Evidence that the whole team is using the same tools: everyone can get to all tools and files|3||
|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 base|3|[Contributers](https://github.com/sam16222/CSC510_43/graphs/contributors)|
|Short release cycles|0|Not present|
|Does your website and documentation provide a clear, high-level overview of your software?|0|No explanation|
|Does your website and documentation clearly describe the type of user who should use your software?|- |N/A|
|Do you publish case studies to show how your software has been used by yourself and others?|-|N/A|
|Is the name of your project/software unique?|1||
|Is your project/software name free from trademark violations?|1||
|Is your software available as a package that can be deployed without building it?|3||
|Is your software available for free?|3||
|Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository?|3||
|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)?|1||
|Is your documentation clearly available on your website or within your software?|0|No 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?|1||
|If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?|2||
|Do you provide a comprehensive guide to all your software’s commands, functions and options?|1||
|Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages?|1||
|If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation?|-|N/A|
|Do you store your documentation under revision control with your source code?|3|GitHub|
|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||
|Does your software describe how a user can get help with using your software?|1||
|Does your website and documentation describe what support, if any, you provide to users and developers?|1||
|Does your project have an e-mail address or forum that is solely for supporting users?|0|Not present|
|Are e-mails to your support e-mail address received by more than one person?|-|N/A| 
|Does your project have a ticketing system to manage bug reports and feature requests?|-|N/A|
|Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests?|-|N/A|
|Is your software’s architecture and design modular?|2||
|Does your software use an accepted coding standard or convention?|3||
|Does your software allow data to be imported and exported using open data formats?|3||
|Does your software allow communications using open communications protocols?|0||
|Is your software cross-platform compatible?|3|Yes with requiremens from requirements.txt |
|Does your software adhere to appropriate accessibility conventions or standards?|3||
|Does your documentation adhere to appropriate accessibility conventions or standards?|2||
|Is your source code stored in a repository under revision control?|3||
|Is each source code release a snapshot of the repository?|3||
|Are releases tagged in the repository?|1|No releases after the initial one|
|Is there a branch of the repository that is always stable?|3||
|Do you back-up your repository?|-|N/A|
|Do you provide publicly-available instructions for building your software from the source code?|3|Yes, in Readme|
|Can you build, or package, your software using an automated tool?|3||
|Do you provide publicly-available instructions for deploying your software?|3||
|Does your documentation list all third-party dependencies?|||
|Does your documentation list the version number for all third-party dependencies?|N/A||
|Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?|3||
|Can you download dependencies using a dependency management tool or package manager?|3||
|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||
|Do you have an automated test suite for your software?|3||
|Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|-|N/A|
|Do you use continuous integration, automatically running tests whenever changes are made to your source code?|3||
|Are your test results publicly visible?|0|Only in errors|
|Are all manually-run tests documented?|0|No comments.|
|Does your project have resources (e.g. blog, Twitter, RSS feed, Facebook page, wiki, mailing list) that are regularly updated with information about your software?|-|N/A|
|Does your website state how many projects and users are associated with your project?|0||
|Do you provide success stories on your website?|0||
|Do you list your important partners and collaborators on your website?|0||
|Do you list your project's publications on your website or link to a resource where these are available?|0||
|Do you list third-party publications that refer to your software on your website or link to a resource where these are available?|0||
|Can users subscribe to notifications to changes to your source code repository?|-|N/A|
|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||
|Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project?|3||
|Do you have a contributions policy?|3||
|Is your contributions' policy publicly available?|3||
|Do contributors keep the copyright/IP of their contributions?|0||
|Does your website and documentation clearly state the copyright owners of your software and documentation?|3||
|Does each of your source code files include a copyright statement?|0||
|Does your website and documentation clearly state the licence of your software?|3||
|Is your software released under an open source licence?|3||
|Is your software released under an OSI-approved open-source licence?|3||
|Does each of your source code files include a licence header?|-|N/A|
|Do you have a recommended citation for your software?|N/A||
|Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?|N/A||
|Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed?|-|N/A|
|Do you make timely announcements of the deprecation of components, APIs, etc.?|-|N/A|