Skip to content

Latest commit

 

History

History
105 lines (103 loc) · 17.9 KB

File metadata and controls

105 lines (103 loc) · 17.9 KB

Project 2 Rubric

|Notes |Self Assessment | Evidence |

TOTAL 102
Video 3 https://drive.google.com/file/d/16slSsPs1yCkgR6VO1seG3Fy4EdmboAFv/view?usp=sharing
workload is spread over the whole team (so 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 Work has been divided equally among all team members.Everyone has almost same number of commits. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/graphs/contributors
Number of commits 3 https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/graphs/commit-activity
Number of commits: by different people 3 The number of commits are almost equal across all team members. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/graphs/contributors
Issues reports: there are many 3 https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/issues
issues are being closed 3 An open issue is closed only after verified by one of the members. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/issues
DOI badge: exists 3 Evidence in readME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Docs: doco generated , format Not ugly 3 Evidence in ReadME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Docs: what: point descriptions of each class/function (in isolation) 3 Description for functions given in the ReadME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z 3 Evidence in ReadME.md.
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing 3 Evidence in ReadME. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. 3 Evidence in ReadME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Use of version control tools 3 https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro
Use of style checkers 3 Yes, pylint config used
Use of code formatters. 3 We used pylint config
Use of syntax checkers. 3 Yes, We used pylint config
Use of code coverage 3 Codecov used and badge present
other automated analysis tools 3 present in github workflows https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/.github/workflows
test cases exist 3 Yes, Test cases exist.
test cases are routinely executed 3 Github actions are used. After every commit to main branch, automated scripts are run for test cases and a badge is shown in the main project folder and README to indicate if build is successful.
the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up 3 Evidence in Contrbuting.md.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/CONTRIBUTING.md
issues are discussed before they are closed 3 After a team member fix the issue, a PR is raised, and the code is reviewed by one of the team members. If any issue is observed, it is communicated through comments in the issue. Once good to be closed, developer is tagged in order to Notify. https://chat.whatsapp.com/CQ0IFAjOB5N7ECAFvMaGRi
Chat channel exists 3 https://chat.whatsapp.com/CQ0IFAjOB5N7ECAFvMaGRi
test cases:.a large proportion of the issues related to handling failing cases. 3 We ensured that every part of the code works correctly.
Evidence that the whole team is using the same tools: everyone can get to all tools and files 3 https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/pulse
evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) 3 1. All the members of the team have set up environments setup locally.
2. Everyone is using the same IDE, packages and tech stack to build the project.
3.Project properly executed by all team-members on their respective systems as part of development and testing. Every team member performed git pull of the develop branch which consists of config files and code files contributed by other team members or by the folks who had previously contributed in this project. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/pulse
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 Project properly executed by all team-members on their respective systems as part of development and testing.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/pulse
evidence that the members of the team are working across multiple places in the code base 3 visible through commits on different files.
Short release cycles 3 https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/releases/
Does your website and documentation provide a clear, high-level overview of your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Does your website and documentation clearly describe the type of user who should use your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Do you publish case studies to show how your software has been used by yourself and others? Yes Yes, Case studies are published.
Is the name of your project/software unique? Yes TaskMasterPro is a unique name and even the logo is unique.
Is your project/software name free from trademark violations? Yes TaskMasterPro is free from trademark violations.
Is your software available as a package that can be deployed without building it? Yes Yes, The package is available. Evidence in ReadME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Is your software available for free? Yes Yes, The software is available for free. All files are available on Github.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository? Yes All files are available on Github for downloading. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
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)? Yes The software is established in Github repository.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Is your documentation clearly available on your website or within your software? Yes Documentation is available within the software.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
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? Yes Quickstart guide is available.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software? Yes Step by step instructions are given. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Do you provide a comprehensive guide to all your software’s commands, functions and options? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation? No
Do you store your documentation under revision control with your source code? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/
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? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Does your software describe how a user can get help with using your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Does your website and documentation describe what support, if any, you provide to users and developers? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Does your project have an e-mail address or forum that is solely for supporting users? Yes Project has an e-mail adress patilharshvardhan0508@gmail.com
Are e-mails to your support e-mail address received by more than one person? Yes Yes, Received by all members of the group. patilharshvardhan0508@@gmail.com
Does your project have a ticketing system to manage bug reports and feature requests? Yes Bug reports and feature requests are managed.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/issues
Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/issues
Is your software’s architecture and design modular? Yes Software is divided into phases. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Does your software use an accepted coding standard or convention? Yes Yes, Accepted coding standards are followed.
Does your software allow data to be imported and exported using open data formats?*e.g. GIF, SVG, HTML, XML, tar, zip, CSV, JSON, NetCDF, or domain specific ones Yes Files can be imported into csv format.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Does your software allow communications using open communications protocols?*e.g. HTTP, FTP, XMPP, SOAP over HTTP, or domain-specific ones Yes Allows communication using open communication protocols. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Is your software cross-platform compatible?*e.g. does it run under two or more of Windows, Unix/Linux and Mac OS X, or can be used from within two or more of Internet Explorer, Chrome, Firefox and Safari? Yes Yes, Software is cross-platform compatible.
Does your software adhere to appropriate accessibility conventions or standards? Yes The software adheres to accessibility conventions and standards.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Is your source code stored in a repository under revision control? Yes Source code stored in a repository under revision control.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Is each source code release a snapshot of the repository? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/releases/
Are releases tagged in the repository? Yes Releases are tagged in repository.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/releases/
Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully) Yes The main branch of the repository is always stable. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Do you back-up your repository? Yes Back-up is done. https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Do you provide publicly-available instructions for building your software from the source code? Yes Evidence in ReadME.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Can you build, or package, your software using an automated tool?e.g. Make (https://www.gnu.org/software/make/), ANT (http://ant.apache.org/), Maven (https://maven.apache.org/), CMake (https://cmake.org/), Python setuptools (https://pypi.python.org/pypi/setuptools), or R package tools (https://cran.r-project.org/doc/manuals/r-devel/R-exts.html) Yes Software can be built or packaged using automated tools.
Do you provide publicly-available instructions for deploying your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md#rocket-installatione
Does your documentation list all third-party dependencies? Yes Documentation lists all third-party dependencies.https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Does your documentation list the version number for all third-party dependencies? Yes Documentation lists the version number for all third party dependencies.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/main/README.md
Can you download dependencies using a dependency management tool or package manager?*e.g. Ivy (http://ant.apache.org/ivy/), Maven (https://maven.apache.org/), Python pip (https://getcomposer.org/), Ruby gems (https://rubygems.org), or R PackRat (https://rstudio.github.io/packrat/)(https://pypi.python.org/pypi/pip) or setuptools (https://pypi.python.org/pypi/setuptools), PHP Composer Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
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? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/todo/tests
Do you have an automated test suite for your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/todo/tests
Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/todo/tests
Do you use continuous integration, automatically running tests whenever changes are made to your source code? Yes
Are your test results publicly visible? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/todo/tests
Are all manually-run tests documented? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/tree/main/todo/tests
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?
e.g. release announcements, publications, workshops, conference presentations Yes
Does your website state how many projects and users are associated with your project? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/graphs/contributors
Do you provide success stories on your website? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Do you list your important partners and collaborators on your website? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/
Do you list your project's publications on your website or link to a resource where these are available? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro
Do you list third-party publications that refer to your software on your website or link to a resource where these are available? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Can users subscribe to Notifications to changes to your source code repository? Yes Evidence in Github repository.
If your software is developed as an open source project (and, not just a project developing open source software), do you have a governance model? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are Not part of your project? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/CONTRIBUTING.md
Do you have a contributions policy? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/CONTRIBUTING.md
Is your contributions' policy publicly available? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/CONTRIBUTING.md
Do contributors keep the copyright/IP of their contributions? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Does your website and documentation clearly state the copyright owners of your software and documentation? Yes Copyright owners of the software and documentation is provided
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Does each of your source code files include a copyright statement? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro
Does your website and documentation clearly state the licence of your software? Yes MIT is the license.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Is your software released under an open source licence? Yes MIT is an open source license.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Is your software released under an OSI-approved open-source licence? Yes MIT is an OSI-approved open source license.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Does each of your source code files include a licence header? Yes All source files include the license header.
https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/LICENSE
Do you have a recommended citation for your software? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/CITATION.md
Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)? Yes https://github.com/SoftwareEngineeringNCSU101/TaskMasterPro/blob/main/README.md
Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed? N/A not applicable
Do you make timely announcements of the deprecation of components, APIs, etc.? N/A Not applicable