Merge pull request #56 from oeg-upm/dev

Fixed minor issue with RSFC-17-1 test

Author: andriumon

CITATION.cff

@@ -26,4 +26,4 @@ keywords:
   - indicators
   - fairness
 license: MIT
-version: 0.0.8
+version: 0.0.9

README.md

@@ -29,6 +29,56 @@ Given a repository URL, RSFC will perform a series of checks based on a list of
 For more information about these RSQIs, you can check https://github.com/EVERSE-ResearchSoftware/indicators. We have plans to implement all of the RSQIs available in that repository.
 
 
+## Available tests
+
+RSFC can perform the following tests:
+
+- RSFC-01-1: There is an identifier and it resolves
+- RSFC-01-2: There is an identifier in the metadata files
+- RSFC-01-3: There is an identifier and it follows a common schema
+- RSFC-03-1: The software has releases
+- RSFC-03-2: Releases have version and identifier
+- RSFC-03-3: Release versions follow SemVer or CalVer
+- RSFC-03-4: Release identifiers follow the same scheme
+- RSFC-03-5: Last release version corresponds to version in package file
+- RSFC-03-6: There is a version number stated in metadata files
+- RSFC-04-1: Metadata files exist
+- RSFC-04-2: There is a README file
+- RSFC-04-3: Title and description are declared
+- RSFC-04-4: There is descriptive metadata
+- RSFC-04-5: There is a codemeta file
+- RSFC-05-1: There is a repostatus badge in the README file
+- RSFC-05-2: Contact and support metadata exists
+- RSFC-05-3: Software documentation exists
+- RSFC-06-1: Authors are declared
+- RSFC-06-2: Contributors are declared
+- RSFC-06-3: Authors have an ORCID assigned
+- RSFC-06-4: Authors have their role stated
+- RSFC-07-1: There is an identifier in README or CITATION
+- RSFC-07-2: Software identifier resolves and links back to software
+- RSFC-08-1: Metadata record is found in SWHeritage or Zenodo
+- RSFC-09-1: Repository is from Github or Gitlab
+- RSFC-12-1: There is an article citation or reference publication
+- RSFC-13-1: Dependencies are declared
+- RSFC-13-2: There are installation instructions
+- RSFC-13-3: Dependencies have version numbers
+- RSFC-13-4: Dependencies are in a machine-readable format
+- RSFC-14-1: Tests are provided
+- RSFC-14-2: There are actions to automate tests
+- RSFC-15-1: There is a license
+- RSFC-15-2: License is in SPDX format
+- RSFC-15-3: License information is provided
+- RSFC-16-1: License is referenced in metadata files
+- RSFC-17-1: The repository has an 'active' status
+- RSFC-17-2: Repository has a commit history
+- RSFC-17-3: Commits are linked to issues
+- RSFC-18-1: There are citations
+- RSFC-19-1: Repository has continuous integration workflows
+- RSFC-20-1: Repository has an issue tracker
+
+**Note**: These will be the identifiers needed to run single-test assessments. More information later in the README
+
+
 ## Requirements
 
 Python 3.10.8 or higher

codemeta.json

@@ -34,6 +34,6 @@
     "operatingSystem": "Linux",
     "programmingLanguage": "Python",
     "relatedLink": "https://github.com/EVERSE-ResearchSoftware/indicators",
-    "version": "0.0.8",
+    "version": "0.0.9",
     "developmentStatus": "wip"
 }

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rsfc"
-version = "0.0.8"
+version = "0.0.9"
 description = "EVERSE Research Software Fairness Checks"
 authors = ["Andres Montero <andres.montero.martin@upm.es>"]
 license = "MIT"

src/rsfc/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 
-__version__ = "0.0.8"
+__version__ = "0.0.9"
 

src/rsfc/rsfc_tests/rsfc_tests.py

@@ -1115,6 +1115,7 @@ def test_commits_linked_issues(gh):
     if commits == [] or issues == []:
         output = "false"
         evidence = constants.EVIDENCE_NOT_ENOUGH_ISSUES_COMMITS_INFO
+        suggest = constants.SUGGEST_NO_COMMITS_OR_ISSUES
     else:
         linked = rsfc_helpers.cross_check_any_issue(issues, commits)
 

src/rsfc/utils/constants.py

@@ -254,7 +254,7 @@
 SUGGEST_NO_ISSUES_LINK_COMMITS = "It is good practice to indicate in your commits which issues you are targeting or solving"
 SUGGEST_NO_ACTIVE_REPO = "You should keep your repository active and indicate it with a repostatus badge"
 SUGGEST_NO_ISSUE_TRACKER = "You should have an issue tracker in your repository to help you manage your ideas, next steps and bugs to fix."
-
+SUGGEST_NO_COMMITS_OR_ISSUES = "Don't forget to make commits of your source code to your git repository and issues to improve version control. More information at https://everse.software/RSQKit/using_version_control"
 
 
 
@@ -419,7 +419,7 @@
     'rsfc' : {
         'name' : 'RSFC',
         'id' : 'https://w3id.org/rsfc/',
-        'version' : '0.0.7'
+        'version' : '0.0.9'
     }
 }