Column B Total: 241.
| Notes | Self Assessment zero (none), one (a litte), two (somewhat), three (a lot) | Evidence |
|---|---|---|
| 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 | Evidence in GH (https://github.com/ineelshah/SRIJAS/graphs/contributors) |
| Number of commits | 3 | In GH (https://github.com/ineelshah/SRIJAS/commits/main) |
| Number of commits: by different people | 3 | Evidence in GH (https://github.com/ineelshah/SRIJAS/commits/main) |
| Issues reports: there are many | 3 | In GH (https://github.com/ineelshah/SRIJAS/issues) |
| issues are being closed | 3 | Evidence in GH (https://github.com/ineelshah/SRIJAS/issues?q=is%3Aissue+is%3Aclosed) |
| DOI badge: exists | 3 | In GH (https://github.com/ineelshah/SRIJAS/blob/main/README.md) |
| Docs: doco generated , format not ugly | 3 | In GH (https://github.com/ineelshah/SRIJAS/tree/main/docs) |
| Docs: what: point descriptions of each class/function (in isolation) | 3 | In GH (https://github.com/ineelshah/SRIJAS/tree/main/docs) |
| Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z | 3 | The demo video shows this (https://github.com/ineelshah/SRIJAS/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 | The demo video and repository homepage (README) shows this (https://github.com/ineelshah/SRIJAS/blob/main/README.md) |
| Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. | 3 | SRIJAS_DEMO.mp4 as attached in the README.md in the repository. (https://github.com/ineelshah/SRIJAS/blob/main/README.md) |
| Use of version control tools | 3 | Git is used thorougly in the project (https://github.com/ineelshah/SRIJAS) |
| Use of style checkers | 3 | config files in GH showing your config (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/style_checker.yml) |
| Use of code formatters. | 3 | config files in GH showing your this formatter's config (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/code_formatter.yml) |
| Use of syntax checkers | 3 | config files in GH showing this checker's config (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/main.yml) |
| Use of code coverage | 3 | In GH (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/code_cov.yml) |
| other automated analysis tools | 3 | config files in GH (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/close_as_a_feature.yml) and (https://github.com/ineelshah/SRIJAS/blob/main/.github/workflows/Respost.yml) |
| test cases exist | 2 | a lot of test cases exist covering almost all the functionalities. |
| test cases are routinely executed | 3 | Github actions and travis CI both are conducting regular tests. |
| the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up | 3 | In GH (https://github.com/ineelshah/SRIJAS/blob/main/CONTRIBUTING.md) |
| issues are discussed before they are closed | 3 | Most discussions on whatsapp, in person, on issue comments, and over calls. (https://github.com/ineelshah/SRIJAS/issues) |
| Chat channel: exists | 3 | Preferred chat channel exists. |
| test cases:.a large proportion of the issues related to handling failing cases. | 2 | if a test case fails, open an issue and fix it (One of many examples: ineelshah#31) |
| evidence that the whole team is using the same tools: everyone can get to all tools and files | 3 | https://github.com/ineelshah/SRIJAS/blob/main/requirements.txt |
| evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | 3 | In GH (https://github.com/ineelshah/SRIJAS/graphs/contributors) |
| 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 | In GH (https://github.com/ineelshah/SRIJAS/graphs/contributors) |
| evidence that the members of the team are working across multiple places in the code base | 3 | In GH (https://github.com/ineelshah/SRIJAS/graphs/contributors) |
| short release cycles | 3 | It is difficult to show this in a small project but here is a release cycle example. (https://github.com/ineelshah/SRIJAS/releases) |
| Documentation provides clear overview of software and uses | 3 | Evidence in GH. https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Website and documentation clearly describe the type of user who should use your software | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Case studies to show how software is used by us | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Project name unique | 3 | SRIJAS is an abbreviation for Smart Resume Interpreter and Job Alert System. |
| Project name free from trademark violations | 3 | We verified that "SRIJAS" has not been trademarked by any python repository or any US company. |
| Software available as a package that can be deployed without building it | 0 | Not yet implemented to be served as a package. |
| Software available for free | 3 | Our repository is public and can be clone and used by anyone. https://github.com/ineelshah/SRIJAS |
| Source code publicly available to download, either as a downloadable bundle or via access to a source code repository | 3 | |
| Software hosted in an established, third-party repository likeGitHub (https://github.com) | 3 | Evidence on GH. (https://github.com/ineelshah/SRIJAS) |
| Documentation clearly available within your software | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Documentation includes a "quick start" guide, that provides a short overview of how to use your software with some basic examples of use | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Providing more extensive documentation, that gives a clear, step-by-step instructions on how to deploy and use our software | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Comprehensive guide to all your software’s commands, functions and options | 3 | We have defined one use case of each command or function that can be performed by our code. |
| Troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages | 0 | NA |
| If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation | 0 | Not Applicable |
| Documentation stored under revision control with source code | 3 | hhttps://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Publishing the release history e.g. release data, version numbers, key features of each release etc. in your documentation | 3 | https://github.com/ineelshah/SRIJAS/releases |
| Software describes how a user can get help with using your software | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Our documentation describes what support we provide to users and developers | 3 | https://github.com/ineelshah/SRIJAS/blob/main/README.md |
| Project has an e-mail address or forum that is solely for supporting users | 3 | [email protected] |
| E-mails to our support e-mail address are received by more than one person | 3 | we all have the access credentials to the support email |
| Project have a ticketing system to manage bug reports and feature requests | 3 | https://github.com/ineelshah/SRIJAS/projects/1 |
| Project's ticketing system publicly visible to your users, so they can view bug reports and feature requests | 3 | https://github.com/ineelshah/SRIJAS/projects/1 |
| Software’s architecture and design is modular | 3 | Modular coding practices were used. |
| Software uses an accepted coding standard or convention | 3 | https://github.com/ineelshah/SRIJAS/blob/main/CODE_OF_CONDUCT.md,https://github.com/ineelshah/SRIJAS/blob/main/CONTRIBUTING.md |
| Software allows data to be imported and exported using open data formats | 3 | Data is imported in the form of resume from the user and is exported in the form of email |
| Software allows communications using open communications protocols | 3 | Yes. SMTP is used for mailing service |
| Software cross-platform compatible | 3 | The only thing needed is python, selenium, PHP and xampp. It will work on all operating systems that have python, selenium, PHP and xampp. |
| Software adhere to appropriate accessibility conventions or standards | 2 | It somewhat does. |
| Documentation adheres to appropriate accessibility conventions or standards | 3 | As seen in documentation. |
| Each source code releases a snapshot of the repository | 0 | Not yet implemented. |
| Releases are tagged in the repository | 3 | https://github.com/ineelshah/SRIJAS/releases |
| There is a branch of the repository that is always stable | 3 | the main branch is always stable |
| Back-up your repository | 3 | We have local backups always available with us. Also, created a release package on zenodo. |
| Provide publicly available instructions for building the software from the source code | 3 | Evidence in GH. (https://github.com/ineelshah/SRIJAS/blob/main/README.md) |
| Build, or package, the software using an automated tool | 3 | Travis CI builds this. (https://app.travis-ci.com/github/ineelshah/SRIJAS) |
| Provide publicly-available instructions for deploying the software | 3 | Evidence in GH. (https://github.com/ineelshah/SRIJAS/tree/main/docs) |
| Documentation list all third-party dependencies | 3 | https://github.com/ineelshah/SRIJAS/blob/main/requirements.txt |
| Documentation lists the version number for all third-party dependencies | 3 | https://github.com/ineelshah/SRIJAS/blob/main/requirements.txt |
| Software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional | 0 | Not yet implemented. |
| Download dependencies using a dependency management tool or package manager | 3 | We install using pip install. |
| Tests that can be run after your software has been built or deployed to show whether the build or deployment has been successful | 3 | Github actions and trais CI implement tests to check this. |
| Automated test suite for your software | 3 | https://github.com/ineelshah/SRIJAS/tree/main/tests |
| Framework to periodically (e.g. nightly) run your tests on the latest version of the source code | 2 | We test the source code on every push/commit to the souce code. |
| Using continuous integration, automatically running tests whenever changes are made to your source code | 3 | https://github.com/ineelshah/SRIJAS/actions/workflows/unit_test.yml |
| Test results publicly visible | 3 | https://github.com/ineelshah/SRIJAS/actions/workflows/unit_test.yml |
| Manually-run tests documented | 2 | Somewhat test cases are documented. Can be found in the tests directory. |
| Project has resources (e.g. blog, Twitter, RSS feed, Facebook page, wiki, mailing list) that are regularly updated with information about your software | 0 | Not yet implemented. |
| Documentation states how many projects and users are associated with your project | 3 | https://github.com/ineelshah/SRIJAS/graphs/contributors |
| Provide success stories on your website | 0 | Not yet implemented. |
| Listing the important partners and collaborators in our documentation | 3 | https://github.com/ineelshah/SRIJAS/graphs/contributors |
| Listing the project's publications on our website or link to a resource where these are available | 1 | No publications yet. |
| Listing third-party publications that refer to the software on our website or link to a resource where these are available | 0 | Not applicable. |
| Users can subscribe to notifications to changes to your source code repository | 3 | Each contributor gets an email when any issues they are assigned gets an update. |
| Since the software is developed as an open source project (and, not just a project developing open source software), do we have a governance model | 0 | No governance model yet. |
| Do we accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project? | 3 | Yes we have not closed this project to accept only contributors to add to the project. It is open source and anyone can contribute. |
| Do you have a contributions policy | Yes (3) | https://github.com/ineelshah/SRIJAS/blob/main/CONTRIBUTING.md |
| Is your contributions' policy publicly available? | Yes (3) | https://github.com/ineelshah/SRIJAS/blob/main/CONTRIBUTING.md |
| Do contributors keep the copyright/IP of their contributions | 0 | The contributors do not keep any copyright since this is open source code. |
| Website and documentation clearly states the copyright owners of your software and documentation | 2 | The github page describes contributors clearly. |
| Do each of your source code files include a copyright statement | 0 | Not yet implemented. |
| The website and documentation clearly state the licence of your software | 3 | https://github.com/ineelshah/SRIJAS/blob/main/LICENSE |
| Software released under an open source licence | Yes (3) | https://github.com/ineelshah/SRIJAS/blob/main/LICENSE |
| Software released under an OSI-approved open-source licence | Yes (3) | https://github.com/ineelshah/SRIJAS/blob/main/LICENSE |
| Source code files include a licence header | 0 | Not yet implemented. |
| Recommended citation for your software | 3 | Evidence on GH. (https://github.com/ineelshah/SRIJAS/blob/main/CITATION.cff) |
| Documentation includes a project roadmap (a list of project and development milestones for the next 3, 6 months) | 3 | The GH readme.md has it. (https://github.com/ineelshah/SRIJAS/blob/main/README.md) |
| Documentation describe how the project is funded, and the period over which funding is guaranteed? | 0 | No funding recieved yet. |
| Do you make timely announcements of the deprecation of components, APIs, etc. | 0 | Not yet implemented. |