| Item |
Assessment |
Evidence |
| Video |
3 |
CSC 510: Software Engineering | Project 3 | WolfTrack5.0 - YouTube |
| 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 |
Pulse · rutuja-39/WolfTrack5.0 (github.com) |
| Number of commits |
3 |
Commit Activity · rutuja-39/WolfTrack5.0 (github.com) |
| Number of commits: by different people |
3 |
Multiple commits from 4 contributors |
| Issues reports: there are many |
3 |
Issues · rutuja-39/WolfTrack5.0 (github.com) |
| Issues are being closed |
3 |
View 1 · Wolftrack (github.com) |
| DOI badge: exists |
3 |
|
| Docs: doco generated, format not ugly |
3 |
rutuja-39/WolfTrack5.0: A personal Job-tracker application (github.com) |
| Docs: what: point descriptions of each class/function (in isolation) |
3 |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z |
3 |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| 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 |
rutuja-39/WolfTrack5.0: A personal Job-tracker application (github.com) |
| Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. |
3 |
CSC 510: Software Engineering | Project 3 | WolfTrack5.0 - YouTube |
| Use of version control tools |
3 |
Git is used for the project through out |
| Use of style checkers |
3 |
WolfTrack5.0/docs/User Guide.pdf at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Use of code formatters. |
3 |
WolfTrack5.0/docs/User Guide.pdf at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Use of syntax checkers. |
3 |
WolfTrack5.0/docs/User Guide.pdf at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Use of code coverage |
3 |
https://app.codecov.io/github/rutuja-39/WolfTrack5.0/tree/Main |
| Other automated analysis tools |
3 |
https://github.com/rutuja-39/WolfTrack5.0/tree/dev/UnitTesting |
| Test cases exist |
3 |
https://github.com/rutuja-39/WolfTrack5.0/tree/dev/UnitTesting |
| Test cases are routinely executed |
2 |
https://github.com/rutuja-39/WolfTrack5.0/actions |
| The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up |
3 |
WolfTrack5.0/CONTRIBUTING.md at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Issues are discussed before they are closed |
3 |
Comments by other contributors present for a few issues |
| Chat channel: exists |
3 |
https://discord.gg/bmaXxb3yg4 |
| Test cases: a large proportion of the issues related to handling failing cases |
2 |
|
| Evidence that the whole team is using the same tools: everyone can get to all tools and files |
3 |
Contributors to rutuja-39/WolfTrack5.0 (github.com) |
| Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) |
3 |
Contributors to rutuja-39/WolfTrack5.0 (github.com) |
| 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 |
Multiple branches can be created and contibutor can pull from any branch to modify |
| Evidence that the members of the team are working across multiple places in the code base |
3 |
Pulse · rutuja-39/WolfTrack5.0 (github.com) |
| Short release cycles |
3 |
Pulse · rutuja-39/WolfTrack5.0 (github.com) |
|
|
|
| Does your website and documentation provide a clear, high-level overview of your software? |
Y |
WolfTrack5.0/docs at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Does your website and documentation clearly describe the type of user who should use your software? |
Y |
WolfTrack5.0/docs at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Do you publish case studies to show how your software has been used by yourself and others? |
Y |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| Is the name of your project/software unique? |
Y |
rutuja-39/WolfTrack5.0: A personal Job-tracker application (github.com) |
| Is your project/software name free from trademark violations? |
Y |
|
| Is your software available as a package that can be deployed without building it? |
Y |
|
| Is your software available for free? |
Y |
|
| Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository? |
Y |
WolfTrack5.0/docs at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Is your software hosted in an established, third-party repository likeGitHub (https://github.com) |
Y |
GitHub |
| Is your documentation clearly available on your website or within your software? |
Y |
WolfTrack5.0/docs at Main · rutuja-39/WolfTrack5.0 (github.com) |
| 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? |
Y |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software? |
Y |
WolfTrack5.0/requirements.txt at Main · rutuja-39/WolfTrack5.0 (github.com) |
| Do you provide a comprehensive guide to all your software’s commands, functions and options? |
Y |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages? |
Y |
|
| If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation? |
N |
|
| Do you store your documentation under revision control with your source code? |
Y |
|
| 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? |
Y |
Release WoftTrack v5.2.0 · rutuja-39/WolfTrack5.0 (github.com) |
| Does your software describe how a user can get help with using your software? |
Y |
rutuja-39/WolfTrack5.0 at dev (github.com) |
| Does your website and documentation describe what support, if any, you provide to users and developers? |
Y |
WolfTrack5.0/docs/UserGuide.pdf at dev · rutuja-39/WolfTrack5.0 (github.com) |
| Does your project have an e-mail address or forum that is solely for supporting users? |
Y |
|
| Are e-mails to your support e-mail address received by more than one person? |
Y |
|
| Does your project have a ticketing system to manage bug reports and feature requests? |
Y |
Contributors to rutuja-39/WolfTrack5.0 (github.com) |
| Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests? |
Y |
View 1 · Wolftrack (github.com) |
| Is your software’s architecture and design modular? |
Y |
|
| Does your software use an accepted coding standard or convention? |
Y |
|
| 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 |
Y |
|
| Does your software allow communications using open communications protocols? e.g. HTTP, FTP, XMPP, SOAP over HTTP, or domain-specific ones |
Y |
|
| 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? |
Y |
|
| Does your software adhere to appropriate accessibility conventions or standards? |
Y |
|
| Does your documentation adhere to appropriate accessibility conventions or standards? |
Y |
|
| Is your source code stored in a repository under revision control? |
Y |
|
| Is each source code release a snapshot of the repository? |
Y |
|
| Are releases tagged in the repository? |
Y |
|
| Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully) |
Y |
dev |
| Do you back-up your repository? |
Y |
dev |
| Do you provide publicly-available instructions for building your software from the source code? |
Y |
|
| Can you build, or package, your software using an automated tool? |
Y |
|
| Do you provide publicly-available instructions for deploying your software? |
Y |
|
| Does your documentation list all third-party dependencies? |
Y |
|
| Does your documentation list the version number for all third-party dependencies? |
Y |
|
| Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional? |
Y |
|
| Can you download dependencies using a dependency management tool or package manager? |
N |
|
| 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? |
N |
|
| Do you have an automated test suite for your software? |
N |
|
| Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code? |
Y |
|
| Do you use continuous integration, automatically running tests whenever changes are made to your source code? |
Y |
https://github.com/rutuja-39/WolfTrack5.0/actions |
| Are your test results publicly visible |
Y |
|
| Are all manually-run tests documented? |
Y |
|
| 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 |
|
| Does your website state how many projects and users are associated with your project? |
Y |
rutuja-39/WolfTrack5.0 at dev (github.com) |
| Do you provide success stories on your website? |
N |
|
| Do you list your important partners and collaborators on your website? |
Y |
|
| Do you list your project's publications on your website or link to a resource where these are available? |
Y |
|
| Do you list third-party publications that refer to your software on your website or link to a resource where these are available? |
N |
|
| Can users subscribe to notifications to changes to your source code repository? |
N |
|
| 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? |
Y |
|
| Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project? |
Y |
|
| Do you have a contributions policy? |
Y |
|
| Is your contributions' policy publicly available? |
Y |
|
| Do contributors keep the copyright/IP of their contributions? |
Y |
|
| Does your website and documentation clearly state the copyright owners of your software and documentation? |
Y |
|
| Does each of your source code files include a copyright statement? |
Y |
|
| Does your website and documentation clearly state the licence of your software? |
Y |
MIT Licence |
| Is your software released under an open source licence? |
Y |
|
| Is your software released under an OSI-approved open-source licence? |
Y |
MIT Licence |
| Does each of your source code files include a licence header? |
N |
|
| Do you have a recommended citation for your software? |
Y |
|
| Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)? |
Y |
|
| 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.? |
Y |
|