diff --git a/proj2/SE project 2.csv b/proj2/SE project 2.csv index e83317ea..3ef4e2de 100644 --- a/proj2/SE project 2.csv +++ b/proj2/SE project 2.csv @@ -1,204 +1,130 @@ -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence -Question,"Score -zero (none), one (a litte), two (somewhat), three (a lot).",Evidence +Question,"Score +zero (none), one (a litte), two (somewhat), three (a lot).",Evidence +,87, +Video,3,GH readme: https://github.com/utsavll0/calorieApp_server/blob/main/README.md +"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,https://github.com/utsavll0/calorieApp_server/graphs/contributors +Number of commits,3,Alteast 365 commits were made +Number of commits: by different people,3,https://github.com/utsavll0/calorieApp_server/graphs/contributors +Issues reports: there are many,3,"3 open, 7 closed: https://github.com/utsavll0/calorieApp_server/issues" +Issues are being closed,3,7 closed: https://github.com/utsavll0/calorieApp_server/issues +DOI badge: exists,3,https://github.com/utsavll0/calorieApp_server/blob/main/README.md +"Docs: doco generated, format not ugly",3,"Not ugly +https://github.com/utsavll0/calorieApp_server/blob/main/README.md" +Docs: what: point descriptions of each class/function (in isolation),3,https://github.com/utsavll0/calorieApp_server/blob/main/README.md +"Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z",3,GH readme youtube video: https://github.com/utsavll0/calorieApp_server/blob/main/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,GH readme youtube video: https://github.com/utsavll0/calorieApp_server/blob/main/README.md +"Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.",3,Video is not hosted on repo rather on a separate link +Use of version control tools,3,Project hosted on github +Use of style checkers,3," +https://github.com/utsavll0/calorieApp_server/actions" +Use of code formatters.,3," +https://github.com/utsavll0/calorieApp_server/actions + +" +Use of syntax checkers.,3,https://github.com/utsavll0/calorieApp_server/actions +Use of code coverage:,3,https://github.com/utsavll0/calorieApp_server/actions +Other automated analysis tools,3,Some linting is there +Test cases exist,3,https://github.com/utsavll0/calorieApp_server/tree/main/tests +Test cases are routinely executed,3,Tests are run on push or creation on PR. https://github.com/utsavll0/calorieApp_server/actions +The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up,3,https://github.com/utsavll0/calorieApp_server/blob/main/CONTRIBUTING.md +Issues are discussed before they are closed,3,"Issues not discussed on github +https://github.com/deekay2310/calorieApp_server/discussions" +Chat channel: exists,3,https://github.com/utsavll0/calorieApp_server/issues +Test cases: a large proportion of the issues related to handling failing cases.,3,GH: no issues opened for failed issues +Evidence that the whole team is using the same tools: everyone can get to all tools and files,3,"Yes, no access control and open-source" +"Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)",3,https://github.com/utsavll0/calorieApp_server/commits/main +"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,https://github.com/utsavll0/calorieApp_server/commits/main +Evidence that the members of the team are working across multiple places in the code base,3,"https://github.com/utsavll0/calorieApp_server/commits/main +yes" +Short release cycles,3,There are many commits done in the time span. A lot of builds were done +Sustainability Questions,, +"Does your website and documentation provide a clear, high-level overview of your software?",Yes,"https://github.com/utsavll0/calorieApp_server/blob/main/README.md +yes" +Does your website and documentation clearly describe the type of user who should use your software?,yes,"https://github.com/utsavll0/calorieApp_server/blob/main/README.md +yes" +Question 1.3: Do you publish case studies to show how your software has been used by yourself and others?,Yes,"Video Provided:- https://github.com/utsavll0/calorieApp_server/blob/main/README.md +" +Question 2.1: Is the name of your project/software unique?*,yes,"Burnout master, burnout bot" +Question 2.2: Is your project/software name free from trademark violations?*,No,No +Question 3.1: Is your software available as a package that can be deployed without building it?,Yes,https://github.com/utsavll0/calorieApp_server/releases/tag/v2.0.0 +Question 3.2: Is your software available for free?*,Yes,Yes it is open source +"Question 3.3: Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository?",Yes,Yes it is open source +"Question 3.4: 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,Yes it uses github +Question 4.1: Is your documentation clearly available on your website or within your software?,Yes,"Yes it is available on github readme +https://github.com/utsavll0/calorieApp_server/blob/main/README.md" +"Question 4.2: 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,"Yes we have provided a video for overview +https://github.com/utsavll0/calorieApp_server/blob/main/README.md" +"Question 4.3: If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software?",yes,"https://github.com/utsavll0/calorieApp_server/blob/main/README.md +yes" +"Question 4.4: Do you provide a comprehensive guide to all your software’s commands, functions and options?",yes,Some functions are listed +Question 4.5: Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages?,No,No such thing +"Question 4.6: If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation?",Yes,Yes https://github.com/utsavll0/calorieApp_server/blob/main/README.md +Question 4.7: Do you store your documentation under revision control with your source code?,Yes," +yes" +"Question 4.8: 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,"Yes +https://github.com/utsavll0/calorieApp_server/releases" +Question 5.1: Does your software describe how a user can get help with using your software?,Yes,Yes https://github.com/deekay2310/calorieApp_server/blob/main/README.md +"Question 5.2: Does your website and documentation describe what support, if any, you provide to users and developers?",No,No support(MIT license) +Question 5.3: Does your project have an e-mail address or forum that is solely for supporting users?,Yes,https://github.com/utsavll0/calorieApp_server/discussions +Question 5.4: Are e-mails to your support e-mail address received by more than one person?,No,no +Question 5.5: Does your project have a ticketing system to manage bug reports and feature requests?,Yes,"Issues tab in github +Links for new feature requests and bug reports given in readme file +https://github.com/utsavll0/calorieApp_server/issues/new/choose" +"Question 5.6: Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests?",Yes,Publicly visible +Question 6.1: Is your software’s architecture and design modular?,Yes,Project structure has been improved but there is still scope for improvement +Question 6.2: Does your software use an accepted coding standard or convention?,Yes,Linting and some project structure are there +"Question 7.1: 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,There is a csv file to import data +"Question 7.2: Does your software allow communications using open communications protocols? * +e.g. HTTP, FTP, XMPP, SOAP over HTTP, or domain-specific ones",Yes,Rest APIs are being used in the project for communication from backend to frontend and vice versa +"Question 8.1: 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,Software is available as a web app which can be run on most popular browsers +Question 9.1: Does your software adhere to appropriate accessibility conventions or standards?,Yes,yes +Question 9.2: Does your documentation adhere to appropriate accessibility conventions or standards?,Yes,Yes +Question 10.1: Is your source code stored in a repository under revision control?,Yes,Github +Question 10.2: Is each source code release a snapshot of the repository?,Yes,"Yes, there are release snapshots +https://github.com/utsavll0/calorieApp_server/releases" +Question 10.3: Are releases tagged in the repository?,Yes,https://github.com/utsavll0/calorieApp_server/releases +"Question 10.4: Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully) *",Yes,There is a main branch which is always stable. +Question 10.5: Do you back-up your repository?,Yes,It is hosted on github +Question 11.1: Do you provide publicly-available instructions for building your software from the source code?,Yes,Clear steps for running the application are given but no instructions are given for importing the csv data file. +"Question 11.2: 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,"Yes, it is a python application and could be built into a python wheel package." +Question 11.3: Do you provide publicly-available instructions for deploying your software?,Yes,Yes https://github.com/utsavll0/calorieApp_server#steps-for-execution +Question 11.4: Does your documentation list all third-party dependencies?,Yes,There is a requirements file +Question 11.5: Does your documentation list the version number for all third-party dependencies?,Yes,The requirements file lists all the version numbers +"Question 11.6: Does your sotware list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional?",Yes,MIT License https://github.com/utsavll0/calorieApp_server/blob/main/LICENSE +"Question 11.7: 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://pypi.python.org/pypi/pip) or setuptools (https://pypi.python.org/pypi/setuptools), PHP Composer (https://getcomposer.org/), Ruby gems (https://rubygems.org), or R PackRat (https://rstudio.github.io/packrat/)",Yes,Yes PIP is used +Question 11.8: 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,There are tests written which runs on push or creation of PR. +Question 12.1: Do you have an automated test suite for your software?,Yes,Yes https://github.com/utsavll0/calorieApp_server/actions/workflows/unit_test.yml. +Question 12.2: Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code?,No,No periodical schedule to travis.yml but it runs on push or creation of PR +"Question 12.3: Do you use continuous integration, automatically running tests whenever changes are made to your source code?",Yes,Yes : https://github.com/utsavll0/calorieApp_server/actions/workflows/unit_test.yml +Question 12.4: Are your test results publicly visible?,Yes,https://github.com/utsavll0/calorieApp_server/actions/workflows/unit_test.yml +Question 12.5: Are all manually-run tests documented?,No,There are no manual tests. +"Question 13.1: 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",No,No such resources +Question 13.2: Does your website state how many projects and users are associated with your project?,Yes,"Yes +Photos of all contributors are shown in readme" +Question 13.3: Do you provide success stories on your website?,No,No evidence of success stories +Question 13.4: Do you list your important partners and collaborators on your website?,Yes,Yes collaborators are mentioned +Question 13.5: Do you list your project's publications on your website or link to a resource where these are available?,No,No evidence +Question 13.6: Do you list third-party publications that refer to your software on your website or link to a resource where these are available?,No,No publications are there. +Question 13.7: Can users subscribe to notifications to changes to your source code repository?,Yes,Github by default allows subscriptions +"Question 13.8: 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,Users can create issues.https://github.com/utsavll0/calorieApp_server/issues.It can't be pushed into main brranch +"Question 14.1: Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project?",Yes,"Yes +https://github.com/utsavll0/calorieApp_server/issues/new/choose" +Question 14.2: Do you have a contributions policy?,Yes,yes +Question 14.3: Is your contributions' policy publicly available?,Yes,"Yes +https://github.com/utsavll0/calorieApp_server/blob/main/CONTRIBUTING.md" +Question 14.4: Do contributors keep the copyright/IP of their contributions?,Yes,We have only MIT license +Question 15.1: Does your website and documentation clearly state the copyright owners of your software and documentation?,Yes,We have MIT license +Question 15.2: Does each of your source code files include a copyright statement?,Yes,Common license +Question 15.3: Does your website and documentation clearly state the licence of your software?,Yes,We have MIT license. https://github.com/utsavll0/calorieApp_server/blob/main/LICENSE +Question 15.4: Is your software released under an open source licence?,Yes,We have an MIT License +Question 15.5: Is your software released under an OSI-approved open-source licence?,Yes,yes +Question 15.6: Does each of your source code files include a licence header?,No,no +Question 15.7: Do you have a recommended citation for your software?,Yes,We have DOI badges. https://zenodo.org/records/8433153 +"Question 16.1: Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)?",No,We do not have roadmaps as such. +"Question 16.2: Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed?",No,Not a funded project +"Question 16.3: Do you make timely announcements of the deprecation of components, APIs, etc.?",No,No such announcements