Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: [FRSM-09] Is the software developed in a code repository / forge that uses standard communications protocols? #10

Open
karacolada opened this issue Nov 10, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@karacolada
Copy link
Member

karacolada commented Nov 10, 2023

D5.2 p17+p27

Detailed Description

Software source code repositories / forges (a.k.a. version control platforms) should use standard communications protocols (such as https / sftp) to enable the widest possible set of contributors.

Domain-agnostic comments

Frameworks such as the Internet Protocol suite and Open Systems Interconnection model define different abstraction layers for networked communication. Several bodies, such as the IETF and ISO define standardised communications protocols utilised at each layer. In general, most widely used code repositories / forges use common standardised communications protocols such as https or sftp. In normal use, this test will be implemented by checking that the repository / forge can be accessed using one of these protocols. Using a software forge that is properly indexed by search engines will help with other aspects of findability.

CESSDA comments

Development of CESSDA tools and services is carried out using CESSDA-owned git-repositories on Github. If the code is developed publicly elsewhere, mirroring with clear pointers to the upstream are used (see docs.

Context

A1: Software is retrievable by its identifier using a standardised communications protocol.
A1.1: The protocol is open, free, and universally implementable.
A1.2: The protocol allows for an authentication and authorization procedure, where necessary.
R3: Software meets domain-relevant community standards.

Possible Implementation

domain-agnostic

requirements Software source code identifier
method Check if the identifier for the code repository / forge can be accessed using standardised communications protocols such as https or sftp.
essential The code repository / forge can be accessed using the identifier via a standardised protocol.
important If authentication or authorisation are required, these are supported by the communication protocols and the repository / forge.
useful n/a

CESSDA

requirements Software source code identifier
method Check that the git repository of the component is accessible using standardised communications protocols such as https or sftp.
essential Ensure that repositories containing component software are publicly accessible.
important No authentication is required to view and/or clone CESSDA’s public repositories, even so, their contents cannot be modified directly by 3rd parties.
useful Pull requests are used to propose modifications to the contents.
@karacolada karacolada added the enhancement New feature or request label Nov 10, 2023
@karacolada
Copy link
Member Author

Extend standardised protocol for data evaluator:

class FAIREvaluatorStandardisedProtocolData(FAIREvaluator):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant