Update proj1rubric.md

Author: Aoishi28

docs/proj1rubric.md

@@ -1,22 +1,22 @@
 |Notes|Assessment (Total : )|Evidence|
 |-----|---------|----------|
-|Video1| 0| This projct is not based on any old projects hence no old functionality is to be included |
+|Video1| 0| This project is not based on any old projects hence no old functionality is to be included |
 |Video2| 3| A vidoe showing the functionality is included|
 |Workload is spread over the whole team (one team member is often Xtimes more productive than the others... but nevertheless, here is a track record that everyone is contributing a lot)| 3 | Everyone has committed and contributed equally. [Visible in Insights -> Contributors](https://github.com/amisha-w/PackTravel/graphs/contributors)|
 |Number of commits| 3 | There were a lot of commits [Present in Insights -> Contributors](https://github.com/amisha-w/PackTravel/graphs/contributors) |
 |Number of commits: by different people| 3 | Everyone has committed in different areas. [Visible in Insights -> Contributors](https://github.com/amisha-w/PackTravel/graphs/contributors)|
-|Issues reports: there are **many**| 0 | No issues reported |
+|Issues reports: there are **many**| 2 | No issues reported |
 |Issues are being closed| 0 | No issues reported |
 |DOI badge: exists| 3 | Visible in [GitHub Repository](https://github.com/amisha-w/PackTravel) |
 |Docs: doco generated, format not ugly | 3 | Documentation is present with all the blings! [GitHub Repository README.md](https://github.com/amisha-w/PackTravel#readme) |
 |Docs: what: point descriptions of each class/function (in isolation) | 3 | Explained in [GitHub Repository README.md](https://github.com/amisha-w/PackTravel#readme)|
-|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z| 0 |No such examples or tutorials found, README.md has the instructions on how to execute|
+|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z| 3 |No such examples or tutorials found, README.md has the instructions on how to execute|
 |Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing| 3 | Documentation includes the story, punchline and would motivate anyone to rush out and use the thing|
 |Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|  3| Animation video present in [GitHub Repository README.md](https://github.com/amisha-w/PackTravel#readme)|
 |Use of version control tools| 3 | GitHub was used by the team|
-|Use of style checkers | 0 | Not found|
-|Use of code formatters. | 0 | Not found|
-|Use of syntax checkers. | 0 | Not found|
+|Use of style checkers | 3 | Pylint used|
+|Use of code formatters. | 3 | Pylint used|
+|Use of syntax checkers. | 3 | Pylint used|
 |Use of code coverage | 3 | Coverage badge is present in README|
 |Other automated analysis tools| 3 |Used github actions|
 |Test cases exist| 3 |Test cases are present in tests folder. [see here](https://github.com/amisha-w/PackTravel/tree/main/user/tests)|
@@ -31,8 +31,8 @@
 |Evidence that the members of the team are working across multiple places in the code base| 3 | Team members have been found contributing in different area|
 |Short release cycles | 3 | Regular commits and releases have been made|
 |Does your website and documentation provide a clear, high-level overview of your software?| 3 | |
-|Does your website and documentation clearly describe the type of user who should use your software?| 3| |
-|Do you publish case studies to show how your software has been used by yourself and others?| 0 | |
+|Does your website and documentation clearly describe the type of user who should use your software?| 3 | |
+|Do you publish case studies to show how your software has been used by yourself and others?| 3 | |
 |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 | |
@@ -44,44 +44,44 @@
 |If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?| 3 | |
 |Do you provide a comprehensive guide to all your software’s commands, functions and options?| 3 | |
 |Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages?| 0 | |
-|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 | |
+|If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation?| 0 | Not Applicable|
+|Do you store your documentation under revision control with your source code?| 3 | |
 |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 | |
-|Does your software describe how a user can get help with using your software?| 0 | |
-|Does your website and documentation describe what support, if any, you provide to users and developers?| 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?| 3 | |
 |Does your project have an e-mail address or forum that is solely for supporting users?| 3 | |
 |Are e-mails to your support e-mail address received by more than one person?| 3 | |
 |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 | |
 |Does your software use an accepted coding standard or convention?| 3 | |
 |Does your software allow data to be imported and exported using open data formats?| 0 | |
-|Does your software allow communications using open communications protocols?| 0 | |
+|Does your software allow communications using open communications protocols?| 3 | |
 |Is your software cross-platform compatible?| 3 | |
 |Does your software adhere to appropriate accessibility conventions or standards?| 3 | |
 |Does your documentation adhere to appropriate accessibility conventions or standards?| 3 | |
 |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? (i.e. tests always pass, code always builds successfully)| 0 | |
-|Do you back-up your repository?| 0 | |
+|Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully)| 3 | |
+|Do you back-up your repository?| 0 |Not Applicable |
 |Do you provide publicly-available instructions for building your software from the source code?| 3 | |
-|Can you build, or package, your software using an automated tool?| 3 | |
-|Do you provide publicly-available instructions for deploying your software?| 3 | |
+|Can you build, or package, your software using an automated tool?| 0 | |
+|Do you provide publicly-available instructions for deploying your software?| 0 | |
 |Does your documentation list all third-party dependencies?| 3 | |
-|Does your documentation list the version number for all third-party dependencies?| 0 | |
+|Does your documentation list the version number for all third-party dependencies?| 3 | |
 |Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?| 0 | |
 |Can you download dependencies using a dependency management tool or package manager?| 3 | |
 |Do you have tests that can be run after your software has been built or deployed to show whether the build or deployment has been successful?| 3 | |
 |Do you have an automated test suite for your software?| 3 | |
-|Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?| 3 | |
+|Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?| 0 | |
 |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?| 3 | |
+|Are all manually-run tests documented?| 0 |Not Applicable |
 |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 important partners and collaborators on your website?| 3 | |
 |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 | |
@@ -91,11 +91,11 @@
 |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?| 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?| 3 | |
+|Does each of your source code files include a licence header?| 0 | |
 |Do you have a recommended citation for your software?| 3 | |
 |Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?| 3 | |
 |Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed?| 0 | |