Back to .md Directory

HW5

|<div style="width:256px">Notes</div>|Assessment|Evidence|

May 2, 2026
0 downloads
0 views
ai rag
View source

HW5

1. https://github.com/smanishs175/group18-HW-2-3-4-5

Total : 135.0

<div style="width:256px">Notes</div>AssessmentEvidence
Video1
Video2
Workload is spread over the whole team (one team member is often Xtimes more productive than the others...1There'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)2Contributers
Number of commits2
Number of commits: by different people1
Issues reports: there are many0No issues were reported.
issues are being closed0No issues were reported.
DOI badge: exists3Present in README
Docs: doco generated, format not ugly0No docs
Docs: what: point descriptions of each class/function (in isolation)0No docs
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z0No Docs
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing0No 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 tools3Git is used well for version control.
Use of style checkers0Not present
Use of code formatters.0Not present
Use of syntax checkers.0Not Present
Use of code coverage0No Code Coverage
Other automated analysis tools-N/A
Test cases exist3Test
Test cases are routinely executed3Present in above mentioned file
The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up3CONTRIBUTING.md
Issues are discussed before they are closed0No 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 files3We 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 base3Contributers
Short release cycles0Not present
Does your website and documentation provide a clear, high-level overview of your software?1No 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?0No 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?3GitHub
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?0Not 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?3Yes. 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?1No 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?3Yes, 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?2Uses 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?0No 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

<div style="width:256px">Notes</div>AssessmentEvidence
Video1
Video2
Workload is spread over the whole team (one team member is often Xtimes more productive than the others...1One 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)2Contributers
Number of commits2
Number of commits: by different people2
Issues reports: there are many0No issues were reported.
issues are being closed0No issues were reported.
DOI badge: exists3Present in README
Docs: doco generated, format not ugly1Readme could have been written better
Docs: what: point descriptions of each class/function (in isolation)3In 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 thing2
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 tools3Git is used well for version control.
Use of style checkers3Style checkers present
Use of code formatters.3There
Use of syntax checkers.3
Use of code coverage0Did not see this
Other automated analysis tools-N/A
Test cases exist3Test
Test cases are routinely executed3Present in above mentioned file
The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up3CONTRIBUTING.md
Issues are discussed before they are closed0No 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 files3We 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 base3Contributers
Short release cycles0Not present
Does your website and documentation provide a clear, high-level overview of your software?3Present 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?3GitHub
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?3Yes, 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?3Yes, 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?3Uses 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?0No 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

<div style="width:256px">Notes</div>AssessmentEvidence
Video1
Video2
Workload is spread over the whole team (one team member is often Xtimes more productive than the others...3All contributors have made significant commits in the codebase.
but nevertheless, here is a track record that everyone is contributing a lot)3Contributers
Number of commits3
Number of commits: by different people3
Issues reports: there are many0No issues were reported.
issues are being closed0No issues were reported.
DOI badge: exists3Present in README
Docs: doco generated, format not ugly0Could not find pydoc generated html.
Docs: what: point descriptions of each class/function (in isolation)3In 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 thing2Sufficient 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 tools3Git is used throughout the project.
Use of style checkers3
Use of code formatters.3
Use of syntax checkers.3
Use of code coverage3Found here
Other automated analysis tools-N/A
Test cases exist3Test
Test cases are routinely executed2Test 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 up3CONTRIBUTING.md
Issues are discussed before they are closed0No 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 files3We 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 base3Contributers
Short release cycles3Releases
Does your website and documentation provide a clear, high-level overview of your software?3README
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?3GitHub
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?3README
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?3In 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?2Uses 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?0No 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

<div style="width:256px">Notes</div>AssessmentEvidence
Video1
Video2
Workload is spread over the whole team (one team member is often Xtimes more productive than the others...3Every team member has made significant contribution to the codebase.
but nevertheless, here is a track record that everyone is contributing a lot)3Contributers
Number of commits3
Number of commits: by different people3
Issues reports: there are many3A good number of issues were reported.
issues are being closed3The issues are being closed periodically.
DOI badge: exists3Badge present in README
Docs: doco generated, format not ugly0Could not find pydoc generated html.
Docs: what: point descriptions of each class/function (in isolation)0Could 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,Z0N/A
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing0N/A
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.0N/A
Use of version control tools3GitHub is used for the project.
Use of style checkers0
Use of code formatters.0
Use of syntax checkers.0
Use of code coverage3Found here
Other automated analysis tools-N/A
Test cases exist3In the same test engineTest
Test cases are routinely executed2Test engine present.
The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up3CONTRIBUTING.md
Issues are discussed before they are closed3The 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 files3Everyone has access to the repository 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 base3Contributers
Short release cycles2Releases
Does your website and documentation provide a clear, high-level overview of your software?1README
Does your website and documentation clearly describe the type of user who should use your software?0No
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)?3Hosted in GitHub. Repo
Is your documentation clearly available on your website or within your software?1No 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?3README
If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?2Documentation can be improved. README
Do you provide a comprehensive guide to all your software’s commands, functions and options?1No document displaying this information in the Repo
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?3GitHub
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?3Code
Does your software use an accepted coding standard or convention?2Code
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?1Documentation not upto the mark
Is your source code stored in a repository under revision control?3Repo
Is each source code release a snapshot of the repository?3
Are releases tagged in the repository?3Releases
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?3InREADME
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?0No
Does your documentation list the version number for all third-party dependencies?3In 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?1No 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?3Test engine present
Do you have an automated test suite for your software?3Uses 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?0No 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?0Repo
Do you provide success stories on your website?0Repo
Do you list your important partners and collaborators on your website?0Repo
Do you list your project's publications on your website or link to a resource where these are available?0Repo
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?3In contributing.md
Do you have a contributions policy?3Can be seen here
Is your contributions' policy publicly available?3contributing.md
Do contributors keep the copyright/IP of their contributions?0No such mention in contributing.md
Does your website and documentation clearly state the copyright owners of your software and documentation?0No such mention in Repo
Does each of your source code files include a copyright statement?0
Does your website and documentation clearly state the licence of your software?3License can be seen here
Is your software released under an open source licence?3License
Is your software released under an OSI-approved open-source licence?3License
Does each of your source code files include a licence header?0No license headers in Code
Do you have a recommended citation for your software?3Citation
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

<div style="width:256px">Notes</div>AssessmentEvidence
Video10NA
Video20NA
Workload is spread over the whole team (one team member is often Xtimes more productive than the others...3Everyone 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)3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/contributors
Number of commits3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/commit-activity
Number of commits: by different people3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/graphs/contributors
Issues reports: there are many0No issues reported
Issues are being closed0No issues were opened
DOI badge: exists3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345
Docs: doco generated, format not ugly3https://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)2Not all functions are commented
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z0NA
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing2https://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.0NA
Use of version control tools3GitHub was used
Use of style checkers0
Use of code formatters.0
Use of syntax checkers.0
Use of code coverage3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/.github/workflows/csv-test.yml
Other automated analysis tools0
Test cases exist3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/tree/main/test
Test cases are routinely executed3https://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 up0
Issues are discussed before they are closed0NA
Chat channel: exists0
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 files3https://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 base3
Short release cycles3
Does your website and documentation provide a clear, high-level overview of your software?3https://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?2https://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?1https://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?3https://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)?3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345
Is your documentation clearly available on your website or within your software?3https://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?3https://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?2https://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?1https://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?3https://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?1https://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?3https://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?3https://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?3https://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?3https://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?1https://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?3https://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?3https://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?3https://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?0CONTRIBUTING.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?3https://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?3https://github.com/CSC-510-Team-31/CSC_510-Team-31_HW2345/blob/main/LICENSE
Is your software released under an open source licence?3https://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?3https://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?3https://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

Related Documents