# HW5 ## 1. https://github.com/smanishs175/group18-HW-2-3-4-5 #### Total : 135.0 |

Notes

|Assessment|Evidence| |--------|------|-------| |Video1||| |Video2||| |Workload is spread over the whole team (one team member is often Xtimes more productive than the others...|1|There's a huge disparity in the number of commits, with one member having added 2636 lines of code and one member having committed 13 lines of code | |but nevertheless, here is a track record that everyone is contributing a lot)|2|[Contributers](https://github.com/smanishs175/group18-HW-2-3-4-5/graphs/contributors)| |Number of commits|2|| |Number of commits: by different people|1|| |Issues reports: there are many|0|No [issues](https://github.com/smanishs175/group18-HW-2-3-4-5/issues?q=is%3Aissue+is%3Aclose) were reported. | |issues are being closed|0|No [issues](https://github.com/smanishs175/group18-HW-2-3-4-5/issues?q=is%3Aissue+is%3Aclose) were reported.| |DOI badge: exists|3|Present in [README](https://github.com/smanishs175/group18-HW-2-3-4-5)| |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.|-|N/A| |Use of version control tools|3|Git is used well for version control.| |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|0|No Code Coverage| |Other automated analysis tools|-|N/A| |Test cases exist|3|[Test](https://github.com/smanishs175/group18-HW-2-3-4-5/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/smanishs175/group18-HW-2-3-4-5/blob/main/CONTRIBUTING.md)| |Issues are discussed before they are closed|0|No issues are present| |Chat channel: exists|-|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|We can clearly see that entire codebase has been written in Python. Everyone has the same access to the repository and also have equal access to committing directly to the main branch.| |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/smanishs175/group18-HW-2-3-4-5/graphs/contributors)| |Short release cycles|0|Not present| |Does your website and documentation provide a clear, high-level overview of your software?|1|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?|3|| |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)?|3|| |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?|3|| |Does your software use an accepted coding standard or convention?|2|| |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. Only requires python installed on the computer| |Does your software adhere to appropriate accessibility conventions or standards?|2|| |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?|2|Uses pytest instead of Test Engine.| |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?|3|| |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| ## 2. https://github.com/VSangarya/SE22-group23-HW1/tree/hw2 #### Total : 166.0 |

Notes

|Assessment|Evidence| |--------|------|-------| |Video1||| |Video2||| |Workload is spread over the whole team (one team member is often Xtimes more productive than the others...|1|One contributor has 9-commits and one has 2, that's a huge difference| |but nevertheless, here is a track record that everyone is contributing a lot)|2|[Contributers](https://github.com/VSangarya/SE22-group23-HW1/graphs/contributors)| |Number of commits|2|| |Number of commits: by different people|2|| |Issues reports: there are many|0|No [issues](https://github.com/VSangarya/SE22-group23-HW1/issues) were reported. | |issues are being closed|0|No [issues](https://github.com/VSangarya/SE22-group23-HW1/issues) were reported.| |DOI badge: exists|3|Present in [README](https://github.com/VSangarya/SE22-group23-HW1)| |Docs: doco generated, format not ugly|1|Readme could have been written better| |Docs: what: point descriptions of each class/function (in isolation)|3|In [CODE](https://github.com/VSangarya/SE22-group23-HW1/tree/hw2/code)| |Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|-|N/A| |Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing|2|| |Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|-|N/A| |Use of version control tools|3|Git is used well for version control.| |Use of style checkers|3|Style checkers present| |Use of code formatters.|3|There| |Use of syntax checkers.|3|| |Use of code coverage|0|Did not see this| |Other automated analysis tools|-|N/A| |Test cases exist|3|[Test](hhttps://github.com/VSangarya/SE22-group23-HW1/blob/hw2/code/test_engine.py)| |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/VSangarya/SE22-group23-HW1/blob/hw2/CONTRIBUTING.md)| |Issues are discussed before they are closed|0|No issues are present| |Chat channel: exists|-|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|We can clearly see that entire codebase has been written in Python. Everyone has the same access to the repository and also have equal access to committing directly to the main branch.| |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/VSangarya/SE22-group23-HW1/graphs/contributors)| |Short release cycles|0|Not present| |Does your website and documentation provide a clear, high-level overview of your software?|3|Present in readme| |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?|3|| |Is your project/software name free from trademark violations?|3|| |Is your software available as a package that can be deployed without building it?|0|| |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)?|3|| |Is your documentation clearly available on your website or within your software?|3|| |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|| |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?|3|| |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?|3|Yes, email present in code of conduct| |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?|3|| |Does your software use an accepted coding standard or convention?|2|| |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|| |Does your software adhere to appropriate accessibility conventions or standards?|2|| |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?|3|| |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|Uses pytest instead of Test Engine.| |Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|1|| |Do you use continuous integration, automatically running tests whenever changes are made to your source code?|3|| |Are your test results publicly visible?|3|| |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?|0|| |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| ## 3. https://github.com/SunandiniM/Group2_HW2 #### Total : 168.0 |

Notes

|Assessment|Evidence| |--------|------|-------| |Video1||| |Video2||| |Workload is spread over the whole team (one team member is often Xtimes more productive than the others...|3|All contributors have made significant commits in the codebase.| |but nevertheless, here is a track record that everyone is contributing a lot)|3|[Contributers](https://github.com/SunandiniM/Group2_HW2/graphs/contributors)| |Number of commits|3|| |Number of commits: by different people|3|| |Issues reports: there are many|0|No [issues](https://github.com/SunandiniM/Group2_HW2/issues) were reported. | |issues are being closed|0|No [issues](https://github.com/SunandiniM/Group2_HW2/issues) were reported.| |DOI badge: exists|3|Present in [README](https://github.com/SunandiniM/Group2_HW2/blob/main/README.md)| |Docs: doco generated, format not ugly|0|Could not find pydoc generated html.| |Docs: what: point descriptions of each class/function (in isolation)|3|In [CODE](https://github.com/SunandiniM/Group2_HW2/tree/main/code)| |Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|-|N/A| |Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing|2|Sufficient comments provided.| |Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|-|N/A| |Use of version control tools|3|Git is used throughout the project.| |Use of style checkers|3|| |Use of code formatters.|3|| |Use of syntax checkers.|3|| |Use of code coverage|3|Found [here](https://github.com/SunandiniM/Group2_HW2/blob/main/.github/workflows/unit-tests.yml)| |Other automated analysis tools|-|N/A| |Test cases exist|3|[Test](https://github.com/SunandiniM/Group2_HW2/tree/main/test)| |Test cases are routinely executed|2|Test engine not included. Pytest used.| |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/SunandiniM/Group2_HW2/blob/main/CONTRIBUTING.md)| |Issues are discussed before they are closed|0|No [issues](https://github.com/SunandiniM/Group2_HW2/issues) were reported.| |Chat channel: exists|-|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|We can clearly see that entire codebase has been written in Python. Everyone has the same access to the repository and also have equal access to committing directly to the main branch.| |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/SunandiniM/Group2_HW2/graphs/contributors)| |Short release cycles|3|[Releases](https://github.com/SunandiniM/Group2_HW2/releases/tag/v3.1.3)| |Does your website and documentation provide a clear, high-level overview of your software?|3|[README](https://github.com/SunandiniM/Group2_HW2/blob/main/README.md)| |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?|3|| |Is your project/software name free from trademark violations?|3|| |Is your software available as a package that can be deployed without building it?|0|| |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)?|3|| |Is your documentation clearly available on your website or within your software?|3|| |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|| |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?|3|| |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|| |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?|3|| |Does your software use an accepted coding standard or convention?|2|| |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|| |Does your software adhere to appropriate accessibility conventions or standards?|2|| |Does your documentation adhere to appropriate accessibility conventions or standards?|1|| |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?|3|| |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|[README](https://github.com/SunandiniM/Group2_HW2/blob/main/README.md)| |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?|3| In requirements.txt| |Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?|1|| |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?|2|Uses pytest instead of Test Engine.| |Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|1|| |Do you use continuous integration, automatically running tests whenever changes are made to your source code?|3|| |Are your test results publicly visible?|3|| |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?|0|| |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?|0|| |Do you have a recommended citation for your software?|0|| |Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?|0|| |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| ## 4. https://github.com/mukunda-p/CSC510-FALL22-HW2345-42.git #### Total : 158.0 |

Notes

|Assessment|Evidence| |--------|------|-------| |Video1||| |Video2||| |Workload is spread over the whole team (one team member is often Xtimes more productive than the others...|3|Every team member has made significant contribution to the codebase.| |but nevertheless, here is a track record that everyone is contributing a lot)|3|[Contributers](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/graphs/contributors)| |Number of commits|3|| |Number of commits: by different people|3|| |Issues reports: there are many|3|A good number of [issues](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/issues) were reported. | |issues are being closed|3|The [issues](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/issues) are being closed periodically.| |DOI badge: exists|3|Badge present in [README](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Docs: doco generated, format not ugly|0|Could not find pydoc generated html.| |Docs: what: point descriptions of each class/function (in isolation)|0|Could not find proper documentation. The code is also poorly commented| |Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|0|N/A| |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|N/A| |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|GitHub is used for the project.| |Use of style checkers|0|| |Use of code formatters.|0|| |Use of syntax checkers.|0|| |Use of code coverage|3|Found [here](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Other automated analysis tools|-|N/A| |Test cases exist|3|In the same test engine[Test](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/tree/master/test)| |Test cases are routinely executed|2|Test engine present.| |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/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CONTRIBUTING.md)| |Issues are discussed before they are closed|3|The [issues](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/issues) had comments / description and were closed.| |Chat channel: exists|-|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| Everyone has access to the [repository](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42) and can commmit directly to the main branch.| |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/mukunda-p/CSC510-FALL22-HW2345-42/graphs/contributors)| |Short release cycles|2|[Releases](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/releases)| |Does your website and documentation provide a clear, high-level overview of your software?|1|[README](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/README.md)| |Does your website and documentation clearly describe the type of user who should use your software?|0|No| |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?|3|| |Is your project/software name free from trademark violations?|3|| |Is your software available as a package that can be deployed without building it?|0|| |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)?|3|Hosted in GitHub. [Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Is your documentation clearly available on your website or within your software?|1|No docs folder| |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](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/README.md)| |If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?|2|Documentation can be improved. [README](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/README.md)| |Do you provide a comprehensive guide to all your software’s commands, functions and options?|1|No document displaying this information in the [Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |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?|3|| |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|| |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?|3|[Code](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/tree/master/code)| |Does your software use an accepted coding standard or convention?|2|[Code](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/tree/master/code)| |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|| |Does your software adhere to appropriate accessibility conventions or standards?|1|| |Does your documentation adhere to appropriate accessibility conventions or standards?|1|Documentation not upto the mark| |Is your source code stored in a repository under revision control?|3|[Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Is each source code release a snapshot of the repository?|3|| |Are releases tagged in the repository?|3|[Releases](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/releases)| |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|In[README](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/README.md)| |Can you build, or package, your software using an automated tool?|3|| |Do you provide publicly-available instructions for deploying your software?|2|| |Does your documentation list all third-party dependencies?|0|No| |Does your documentation list the version number for all third-party dependencies?|3| In [requirements.txt](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/requirements.txt)| |Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?|1|No further description except the version number. | |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|Test engine present| |Do you have an automated test suite for your software?|3|Uses a Test Engine.| |Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|1|| |Do you use continuous integration, automatically running tests whenever changes are made to your source code?|1|| |Are your test results publicly visible?|3|| |Are all manually-run tests documented?|0|No proper documentation| |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|[Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Do you provide success stories on your website?|0|[Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Do you list your important partners and collaborators on your website?|0|[Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |Do you list your project's publications on your website or link to a resource where these are available?|0|[Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |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|In [contributing.md](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CONTRIBUTING.md)| |Do you have a contributions policy?|3|Can be seen [here](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CONTRIBUTING.md)| |Is your contributions' policy publicly available?|3|[contributing.md](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CONTRIBUTING.md)| |Do contributors keep the copyright/IP of their contributions?|0|No such mention in [contributing.md](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CONTRIBUTING.md)| |Does your website and documentation clearly state the copyright owners of your software and documentation?|0|No such mention in [Repo](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42)| |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|License can be seen [here](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/LICENSE.md)| |Is your software released under an open source licence?|3|[License](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/LICENSE.md)| |Is your software released under an OSI-approved open-source licence?|3|[License](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/LICENSE.md)| |Does each of your source code files include a licence header?|0|No license headers in [Code](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/tree/master/code)| |Do you have a recommended citation for your software?|3|[Citation](https://github.com/mukunda-p/CSC510-FALL22-HW2345-42/blob/master/CITATION.cff)| |Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?|0|| |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| ## 5. https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345 ### Total: 159.0 |

Notes

|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...|3|Everyone has made an equal contribution https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/contributors| |but nevertheless, here is a track record that everyone is contributing a lot)|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/contributors| |Number of commits|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/commit-activity| |Number of commits: by different people|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/contributors| |Issues reports: there are many|0|No issues reported| |Issues are being closed|0|No issues were opened| |DOI badge: exists|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Docs: doco generated, format not ugly|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/README.md| |Docs: what: point descriptions of each class/function (in isolation)|2|Not all functions are commented| |Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z|0|NA| |Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing|2|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/README.md| |Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|0|NA| |Use of version control tools|3|GitHub was used| |Use of style checkers|0|| |Use of code formatters.|0|| |Use of syntax checkers.|0|| |Use of code coverage|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/.github/workflows/csv-test.yml| |Other automated analysis tools|0|| |Test cases exist|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/test| |Test cases are routinely executed|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/src/example.py| |The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up|0|| |Issues are discussed before they are closed|0|NA| |Chat channel: exists|0|| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/search?l=python| |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|| |Short release cycles|3|| |Does your website and documentation provide a clear, high-level overview of your software?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Does your website and documentation clearly describe the type of user who should use your software?|2|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Do you publish case studies to show how your software has been used by yourself and others?|1|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Is the name of your project/software unique?|3|| |Is your project/software name free from trademark violations?|3|| |Is your software available as a package that can be deployed without building it?|0|| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Is your documentation clearly available on your website or within your software?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?|2|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Do you provide a comprehensive guide to all your software’s commands, functions and options?|1|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/src| |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?|0|| |Do you store your documentation under revision control with your source code?|0|| |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?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/releases/tag/tag1| |Does your software describe how a user can get help with using your software?|1|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |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|| |Are e-mails to your support e-mail address received by more than one person?|0|| |Does your project have a ticketing system to manage bug reports and feature requests?|0|| |Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests?|0|| |Is your software’s architecture and design modular?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/src| |Does your software use an accepted coding standard or convention?|2|| |Does your software allow data to be imported and exported using open data formats?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/data| |Does your software allow communications using open communications protocols?|1|| |Is your software cross-platform compatible?|2|| |Does your software adhere to appropriate accessibility conventions or standards?|2|| |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?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/releases/tag/tag1| |Is there a branch of the repository that is always stable?|3|| |Do you back-up your repository?|0|| |Do you provide publicly-available instructions for building your software from the source code?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345| |Can you build, or package, your software using an automated tool?|2|| |Do you provide publicly-available instructions for deploying your software?|3|| |Does your documentation list all third-party dependencies?|0|| |Does your documentation list the version number for all third-party dependencies?|0|| |Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?|1|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/LICENSE| |Can you download dependencies using a dependency management tool or package manager?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/.github/workflows/csv-test.yml| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/test| |Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?|1|| |Do you use continuous integration, automatically running tests whenever changes are made to your source code?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/.github/workflows/csv-test.yml| |Are your test results publicly visible?|3|| |Are all manually-run tests documented?|2|| |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?|0|| |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?|0|| |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?|2|| |Do you have a contributions policy?|0|CONTRIBUTING.md file not found| |Is your contributions' policy publicly available?|0|| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/CITATION.cff| |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|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/LICENSE| |Is your software released under an open source licence?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/LICENSE| |Is your software released under an OSI-approved open-source licence?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/LICENSE| |Does each of your source code files include a licence header?|0|| |Do you have a recommended citation for your software?|3|https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/CITATION.cff| |Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?|0|| |Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed?|0|| |Do you make timely announcements of the deprecation of components, APIs, etc.?|0||

Coding & Development

HW5