Skip to content
Snippets Groups Projects
Commit 2250116e authored by Simon Sendler's avatar Simon Sendler :turtle:
Browse files

style(rdd-technical-reference.md): lint markdown

parent 55c3e6e8
No related branches found
No related tags found
1 merge request!24Resolve "Onboarding information"
Hide whitespace changes
Inline Side-by-side
rdd-technical-reference.md
+ 66
− 80
View file @ 2250116e
...@@ -2,7 +2,6 @@ ...@@ -2,7 +2,6 @@
title: 'SUB RDD Technical Reference' title: 'SUB RDD Technical Reference'
... ...
# About This Document # About This Document
**Author**: Software Quality Working Group\ **Author**: Software Quality Working Group\
...@@ -16,15 +15,14 @@ Our goal is to establish better software quality by following standards the deve ...@@ -16,15 +15,14 @@ Our goal is to establish better software quality by following standards the deve
**Status**: This document is a living document and will be extended as soon as the Software Quality Working Group has agreed upon a new standard for software projects in RDD. **Status**: This document is a living document and will be extended as soon as the Software Quality Working Group has agreed upon a new standard for software projects in RDD.
TODOs and addenda of this document are maintained [here](https://github.com/subugoe/rdd-technical-reference/issues/). TODOs and addenda of this document are maintained [here](https://github.com/subugoe/rdd-technical-reference/issues/).
# Explanatory Notes # Explanatory Notes
**CESSDA's Software Maturity Levels (SML)**: Several organizations already have put a lot of work into developing metrics for good software. Since we didn't want to reinvent the wheel, we decided to adapt (and modify if need be) a metric which suits our needs. [CESSDA](https://www.cessda.eu/) is one of the ERICs, and although it focuses on Social Sciences it has similar requirements regarding its software. **CESSDA's Software Maturity Levels (SML)**: Several organizations already have put a lot of work into developing metrics for good software. Since we didn't want to reinvent the wheel, we decided to adapt (and modify if need be) a metric which suits our needs. [CESSDA](https://www.cessda.eu/) is one of the ERICs, and although it focuses on Social Sciences it has similar requirements regarding its software.
Throughout the document you will find sections with the heading "CESSDA's Software Maturity Levels in RDD" in which we describe which of the SMLs we aim for and how we want to implement it. Throughout the document you will find sections with the heading "CESSDA's Software Maturity Levels in RDD" in which we describe which of the SMLs we aim for and how we want to implement it.
# FE-Onboarding # FE-Onboarding
This section focuses on the specific needs and requirements of developers new This section focuses on the specific needs and requirements of developers new
to the department. Please also refer to any of the general information on to the department. Please also refer to any of the general information on
onboarding within the department, as well as the departmental mentoring onboarding within the department, as well as the departmental mentoring
...@@ -34,9 +32,11 @@ of relevant and useful mailing lists new developers ought to consider ...@@ -34,9 +32,11 @@ of relevant and useful mailing lists new developers ought to consider
subscribing to is provided at the end of the section. subscribing to is provided at the end of the section.
## Skills & Tools ## Skills & Tools
Here you will find a list of skills and tools that a developer will likely Here you will find a list of skills and tools that a developer will likely
need at one point or another during their tenure at FE. We assume a basic need at one point or another during their tenure at FE. We assume a basic
familiarity with basal technologies such as XML. familiarity with basal technologies such as XML.
- Ant - Ant
- GitLab CI/CD - GitLab CI/CD
- Implementation of DARIAH-AAI - Implementation of DARIAH-AAI
...@@ -47,6 +47,7 @@ familiarity with basal technologies such as XML. ...@@ -47,6 +47,7 @@ familiarity with basal technologies such as XML.
- SADE - SADE
## Repos & Groups ## Repos & Groups
- The departmental group at github: `https://github.com/subugoe/teams/fe` - The departmental group at github: `https://github.com/subugoe/teams/fe`
- The departmental group at GitLab.gwdg.de: `https://gitlab.gwdg.de/fe` - The departmental group at GitLab.gwdg.de: `https://gitlab.gwdg.de/fe`
- The SUB-wide group at GitLab.gwdg.de: `https://gitlab.gwdg.de/subugoe` - The SUB-wide group at GitLab.gwdg.de: `https://gitlab.gwdg.de/subugoe`
...@@ -58,17 +59,18 @@ familiarity with basal technologies such as XML. ...@@ -58,17 +59,18 @@ familiarity with basal technologies such as XML.
- Kanboard-user group FE - Kanboard-user group FE
## Mailing Lists ## Mailing Lists
- eXist-db (eXist open mailing list) - eXist-db (eXist open mailing list)
- de-RSE - de-RSE
- RfII - RfII
- relevant TEI-lists - relevant TEI-lists
## Further Reading ## Further Reading
- RDD Technical Reference: https://github.com/subugoe/rdd-technical-reference
- RDD Technical Reference: <https://github.com/subugoe/rdd-technical-reference>
- DH-FE-Zoterobibliothek - DH-FE-Zoterobibliothek
- Heise, Golem, etc. - Heise, Golem, etc.
# Style Guides # Style Guides
## General ## General
...@@ -88,8 +90,8 @@ For the more prominent programming languages we have formatting and general styl ...@@ -88,8 +90,8 @@ For the more prominent programming languages we have formatting and general styl
- **XQuery**: We use the [xqdoc style guide](http://xqdoc.org/xquery-style.pdf) with the following addenda: - **XQuery**: We use the [xqdoc style guide](http://xqdoc.org/xquery-style.pdf) with the following addenda:
- use double quotes instead of single quotes (for easy escaping) - use double quotes instead of single quotes (for easy escaping)
- use four spaces for a TAB (because eXide switching the preferences in eXide's setting isn't permanent) - use four spaces for a TAB (because eXide switching the preferences in eXide's setting isn't permanent)
- **XSLT**: Since there is no official style guide for XSLT, we decided to write - **XSLT**: Since there is no official style guide for XSLT, we decided to write
[our own](https://github.com/subugoe/rdd-technical-reference/tree/master/style-guides/rdd-xslt.md), resulting from common best practices and own experiences within [our own](https://github.com/subugoe/rdd-technical-reference/tree/master/style-guides/rdd-xslt.md), resulting from common best practices and own experiences within
...@@ -99,7 +101,6 @@ the department. ...@@ -99,7 +101,6 @@ the department.
- **SPARQL**: For SPARQL there is not really any official style guide and there is no possibility to simply include any code style automatically using a code style file. We just collect some advice how to format and use SPARQL code [here](https://github.com/subugoe/rdd-technical-reference/tree/master/style-guides/rdd-sparql.md). - **SPARQL**: For SPARQL there is not really any official style guide and there is no possibility to simply include any code style automatically using a code style file. We just collect some advice how to format and use SPARQL code [here](https://github.com/subugoe/rdd-technical-reference/tree/master/style-guides/rdd-sparql.md).
# Documentation # Documentation
## Doc Sprints ## Doc Sprints
...@@ -117,19 +118,19 @@ To ensure the best documentation of our code we meet on a weekly base for a code ...@@ -117,19 +118,19 @@ To ensure the best documentation of our code we meet on a weekly base for a code
This refers both to the documentation in a repository and in the code itself, e.g. inline documentation. This refers both to the documentation in a repository and in the code itself, e.g. inline documentation.
- Every code repository MUST have: - Every code repository MUST have:
- a README.md file according to [this template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) that contains - a README.md file according to [this template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) that contains
- link to original repository (if the software is forked or otherwise based on preexisting software) - link to original repository (if the software is forked or otherwise based on preexisting software)
- short introduction on what the repository is about - short introduction on what the repository is about
- a guide how to get the software running (if makes sense) - a guide how to get the software running (if makes sense)
- link to demo instance - link to demo instance
- example or demo installation - example or demo installation
- link to license file - link to license file
- contribution guide - contribution guide
- link to style guide - link to style guide
- link to bug tracker/project management system - link to bug tracker/project management system
- known issues - known issues
- badges to CI status - badges to CI status
- a LICENSE file - a LICENSE file
## Developer Documentation ## Developer Documentation
...@@ -153,7 +154,6 @@ Call diagrams can be useful to follow code and service calls and should be exist ...@@ -153,7 +154,6 @@ Call diagrams can be useful to follow code and service calls and should be exist
- Document REST-APIs using [openAPI](https://github.com/OAI/OpenAPI-Specification) if possible. OpenAPI docs should be located at `/doc/api` on servers. - Document REST-APIs using [openAPI](https://github.com/OAI/OpenAPI-Specification) if possible. OpenAPI docs should be located at `/doc/api` on servers.
### CESSDA's Software Maturity Levels in RDD (CA1.3) ### CESSDA's Software Maturity Levels in RDD (CA1.3)
#### MUST #### MUST
...@@ -163,11 +163,11 @@ Call diagrams can be useful to follow code and service calls and should be exist ...@@ -163,11 +163,11 @@ Call diagrams can be useful to follow code and service calls and should be exist
> There is external documentation that describes public API functionality and is sufficient to be used by an experienced developer. If available, source code is consistently and clearly commented. Source code naming conventions are adhered to and consistent. > There is external documentation that describes public API functionality and is sufficient to be used by an experienced developer. If available, source code is consistently and clearly commented. Source code naming conventions are adhered to and consistent.
#### Actions to Be Taken in RDD #### Actions to Be Taken in RDD
- provide a fully documented public API, e.g. by using OpenAPI - provide a fully documented public API, e.g. by using OpenAPI
- naming conventions still have to be discussed --> style guide? - naming conventions still have to be discussed --> style guide?
- reference to style guide used in the CONTRIBUTING/README file? - reference to style guide used in the CONTRIBUTING/README file?
## Admin Documentation ## Admin Documentation
- The docs should comprise how to install the software, how to run and/or restart it, how to test the installation, ... - The docs should comprise how to install the software, how to run and/or restart it, how to test the installation, ...
...@@ -181,19 +181,17 @@ Call diagrams can be useful to follow code and service calls and should be exist ...@@ -181,19 +181,17 @@ Call diagrams can be useful to follow code and service calls and should be exist
> There is a deployment and configuration manual that can guide an experienced operational user through deployment, management and configuration of the software. Exception and failure messages are explained, but descriptions of solutions are not available. Documentation is consistent with current version of the software. > There is a deployment and configuration manual that can guide an experienced operational user through deployment, management and configuration of the software. Exception and failure messages are explained, but descriptions of solutions are not available. Documentation is consistent with current version of the software.
#### Actions to Be Taken in RDD #### Actions to Be Taken in RDD
- deployment: short deployment descriptions can be provided in the README, more detailed explanations should be kept separately (such as INSTALL(.md), linked from README) - deployment: short deployment descriptions can be provided in the README, more detailed explanations should be kept separately (such as INSTALL(.md), linked from README)
- exception and failure messages are described in doc strings/function annotations - exception and failure messages are described in doc strings/function annotations
- function documentation should be generated automatically and made available/searchable in the web (such as readthedocs, javadoc html, etc. pp.) - function documentation should be generated automatically and made available/searchable in the web (such as readthedocs, javadoc html, etc. pp.)
## Server Documentation ## Server Documentation
This type of documentation is provided and maintained in our DARIAH wiki space.\ This type of documentation is provided and maintained in our DARIAH wiki space.\
We have a template encompassing all information necessary: To create a wiki page for a new server navigate to the FE Server list, select "..." right beside the "Create" button and search for "FE-Server". We have a template encompassing all information necessary: To create a wiki page for a new server navigate to the FE Server list, select "..." right beside the "Create" button and search for "FE-Server".
## User Documentation ## User Documentation
This may encompass: This may encompass:
...@@ -202,20 +200,21 @@ This may encompass: ...@@ -202,20 +200,21 @@ This may encompass:
- guided tour (Bootstrap Tour) as user documentation - guided tour (Bootstrap Tour) as user documentation
- for SADE portal usage (such as Fontane, BdN, Architrave) - for SADE portal usage (such as Fontane, BdN, Architrave)
- for complex Digital Editions - for complex Digital Editions
- screencasts - screencasts
### CESSDA's Software Maturity Levels in RDD (CA1.1) ### CESSDA's Software Maturity Levels in RDD (CA1.1)
#### MUST #### MUST
`MUST` be SML2, which is defined as follows: `MUST` be SML2, which is defined as follows:
> There is external documentation that is accessible and sufficient for an expert user to configure and use the software for the user’s individual needs. Terminology and methodology is not explained. > There is external documentation that is accessible and sufficient for an expert user to configure and use the software for the user’s individual needs. Terminology and methodology is not explained.
##### Actions to Be Taken in RDD ##### Actions to Be Taken in RDD
- a README(.md) has to be available in the source code repository (cf. [General Notions about Documentation](#general-notions-about-documentation)) - a README(.md) has to be available in the source code repository (cf. [General Notions about Documentation](#general-notions-about-documentation))
#### SHOULD #### SHOULD
...@@ -225,12 +224,11 @@ This may encompass: ...@@ -225,12 +224,11 @@ This may encompass:
> There is a user manual that can guide a reasonably skilled user through use and customisation of the software to the user’s individual requirements. Documentation is consistent with current version of the software. > There is a user manual that can guide a reasonably skilled user through use and customisation of the software to the user’s individual requirements. Documentation is consistent with current version of the software.
##### Actions to Be Taken in RDD ##### Actions to Be Taken in RDD
- a more detailed explanation is available for the user at some place (such as user guide in wikis, etc. pp.) - a more detailed explanation is available for the user at some place (such as user guide in wikis, etc. pp.)
- docs should also be provided in a `docs` directory in the source code repository - docs should also be provided in a `docs` directory in the source code repository
- docs are revised regularly during our doc sprints - docs are revised regularly during our doc sprints
# Version Control # Version Control
We exclusively use `git` in RDD. Please see <https://git-scm.com/doc> for information on how it works. We exclusively use `git` in RDD. Please see <https://git-scm.com/doc> for information on how it works.
...@@ -255,7 +253,6 @@ We use the following Git servers at the moment in RDD: ...@@ -255,7 +253,6 @@ We use the following Git servers at the moment in RDD:
- GitLab (GWDG) --> <https://gitlab.gwdg.de> - GitLab (GWDG) --> <https://gitlab.gwdg.de>
- github.org --> <https://github.com/subugoe> - github.org --> <https://github.com/subugoe>
Which one is suitable for you depends on: Which one is suitable for you depends on:
- the project you are working on - the project you are working on
...@@ -263,19 +260,14 @@ Which one is suitable for you depends on: ...@@ -263,19 +260,14 @@ Which one is suitable for you depends on:
- whether or not you want to use CI/CD or GitLab Runners - whether or not you want to use CI/CD or GitLab Runners
- ... - ...
We have got an [RDD team on GitHub](https://github.com/orgs/subugoe/teams/fe). Feel free to join us! We have got an [RDD team on GitHub](https://github.com/orgs/subugoe/teams/fe). Feel free to join us!
Consider mirroring of repos for project visibility (e.g. mirror GitLab/Projects code to GitHub?) Consider mirroring of repos for project visibility (e.g. mirror GitLab/Projects code to GitHub?)
# Bug Tracking # Bug Tracking
A bug tracking system is obligatory! Please use the respective bug tracking system of your repo and/or project management solution (please see chapter [Version Control](#version-control))! A bug tracking system is obligatory! Please use the respective bug tracking system of your repo and/or project management solution (please see chapter [Version Control](#version-control))!
# Software Tests # Software Tests
We aim to have a test coverage of **100%** (except for getter and setter methods). This is understood on a component level, which means that every method should have at least one test. Whether you achieve this by Test Driven Development (TDD) or not is specific to your preferred way to work. We aim to have a test coverage of **100%** (except for getter and setter methods). This is understood on a component level, which means that every method should have at least one test. Whether you achieve this by Test Driven Development (TDD) or not is specific to your preferred way to work.
...@@ -288,7 +280,6 @@ Examples for writing tests in different programming languages are: ...@@ -288,7 +280,6 @@ Examples for writing tests in different programming languages are:
- [**XQuery**](https://gist.github.com/joewiz/fa32be80749a69fcb8da) - [**XQuery**](https://gist.github.com/joewiz/fa32be80749a69fcb8da)
# Building Code and Continuous Integration # Building Code and Continuous Integration
## Building Code ## Building Code
...@@ -301,20 +292,19 @@ The reason for using a build tool is to be able to build and/or test a code proj ...@@ -301,20 +292,19 @@ The reason for using a build tool is to be able to build and/or test a code proj
* **bash scripting**: (bdnPrint, FontanePrint) * **bash scripting**: (bdnPrint, FontanePrint)
* **eXist**: Ant (SADE) * **eXist**: Ant (SADE)
* **Java**: * **Java**:
- Maven (TextGrid) - Maven (TextGrid)
- gradle (TextGrid) - gradle (TextGrid)
* **JavaScript**: * **JavaScript**:
- bower (DARIAH-DE GeoBrowser, tgForms) - bower (DARIAH-DE GeoBrowser, tgForms)
- cake (tgForms) - cake (tgForms)
- NPM (DARIAH-DE Publikator, tgForms) - NPM (DARIAH-DE Publikator, tgForms)
- rake (DARIAH-DE GeoBrowser) - rake (DARIAH-DE GeoBrowser)
* **Python**: * **Python**:
- make (Sphinx documentation) - make (Sphinx documentation)
- PIP (DiscussData) - PIP (DiscussData)
* **Ruby**: bundler (DARIAH status page) * **Ruby**: bundler (DARIAH status page)
## Packaging ## Packaging
### CESSDA's Software Maturity Levels in RDD (CA5) ### CESSDA's Software Maturity Levels in RDD (CA5)
...@@ -326,11 +316,10 @@ The reason for using a build tool is to be able to build and/or test a code proj ...@@ -326,11 +316,10 @@ The reason for using a build tool is to be able to build and/or test a code proj
> Demonstrable usability: A Continuous Integration server job (or equivalent) is available to deploy the packaged/containerised software. Administrators are notified if deployment fails. Versions of deployed software can be upgraded/rolled back from a Continuous Integration server job (or equivalent). Data and/or index files can be restored from a Continuous Integration server job (or equivalent). > Demonstrable usability: A Continuous Integration server job (or equivalent) is available to deploy the packaged/containerised software. Administrators are notified if deployment fails. Versions of deployed software can be upgraded/rolled back from a Continuous Integration server job (or equivalent). Data and/or index files can be restored from a Continuous Integration server job (or equivalent).
##### Actions to Be Taken in RDD ##### Actions to Be Taken in RDD
- examples for versions of deployed software: versioning of deb packages - examples for versions of deployed software: versioning of deb packages
- examples for rollback: rebuild index ElasticSearch from source data, restore database backup - examples for rollback: rebuild index ElasticSearch from source data, restore database backup
## Continuous Integration ## Continuous Integration
We want to use CI as soon as possible in new projects. Please set up your GitLab project to show your pipeline-status and test-coverage for your default-branch under Settings/General->Badges. We want to use CI as soon as possible in new projects. Please set up your GitLab project to show your pipeline-status and test-coverage for your default-branch under Settings/General->Badges.
...@@ -338,11 +327,11 @@ We want to use CI as soon as possible in new projects. Please set up your GitLab ...@@ -338,11 +327,11 @@ We want to use CI as soon as possible in new projects. Please set up your GitLab
The generic links for all projects are: The generic links for all projects are:
* Pipeline-status * Pipeline-status
- Link: `https://gitlab.gwdg.de/%{project_path}/commits/%{default_branch}` - Link: `https://gitlab.gwdg.de/%{project_path}/commits/%{default_branch}`
- Badge image URL: `https://gitlab.gwdg.de/%{project_path}/badges/%{default_branch}/pipeline.svg?style=flat-square` - Badge image URL: `https://gitlab.gwdg.de/%{project_path}/badges/%{default_branch}/pipeline.svg?style=flat-square`
* Test-coverage * Test-coverage
- Link: `https://gitlab.gwdg.de/%{project_path}/commits/%{default_branch}` - Link: `https://gitlab.gwdg.de/%{project_path}/commits/%{default_branch}`
- Badge image URL: `https://gitlab.gwdg.de/%{project_path}/badges/%{default_branch}/coverage.svg?style=flat-square` - Badge image URL: `https://gitlab.gwdg.de/%{project_path}/badges/%{default_branch}/coverage.svg?style=flat-square`
The workflows we are using currently in Jenkins and GitLab Runner are: The workflows we are using currently in Jenkins and GitLab Runner are:
...@@ -357,7 +346,6 @@ The workflows we are using currently in Jenkins and GitLab Runner are: ...@@ -357,7 +346,6 @@ The workflows we are using currently in Jenkins and GitLab Runner are:
There is a [full and documented example](https://gitlab.gwdg.de/SADE/SADE/blob/develop/.gitlab-ci.yml) of how the GitLab Runner is used in SADE. There is a [full and documented example](https://gitlab.gwdg.de/SADE/SADE/blob/develop/.gitlab-ci.yml) of how the GitLab Runner is used in SADE.
### Sample Configuration of the Jenkins CI (Multibranch Pipelines) ### Sample Configuration of the Jenkins CI (Multibranch Pipelines)
- On commit and push to the <https://projects.gwdg.de> gitolite repo (such as <https://projects.gwdg.de/projects/tg-crud/repository>) Jenkins on [ci.de.dariah.eu](https://ci.de.dariah.eu/jenkins) is notified (see projects' gitolite configuration) - On commit and push to the <https://projects.gwdg.de> gitolite repo (such as <https://projects.gwdg.de/projects/tg-crud/repository>) Jenkins on [ci.de.dariah.eu](https://ci.de.dariah.eu/jenkins) is notified (see projects' gitolite configuration)
...@@ -370,7 +358,6 @@ There is a [full and documented example](https://gitlab.gwdg.de/SADE/SADE/blob/d ...@@ -370,7 +358,6 @@ There is a [full and documented example](https://gitlab.gwdg.de/SADE/SADE/blob/d
- Stage *Publish*: Publish DEB packages to the [DARIAH-DE Aptly Repo](https://ci.de.dariah.eu/aptly). Jenkins is using a shared library of scripts and publishing is devided into four conditionals: TG version, DH version, SNAPSHOT version, or RELEASE version due to given version suffixes! - Stage *Publish*: Publish DEB packages to the [DARIAH-DE Aptly Repo](https://ci.de.dariah.eu/aptly). Jenkins is using a shared library of scripts and publishing is devided into four conditionals: TG version, DH version, SNAPSHOT version, or RELEASE version due to given version suffixes!
# Deployment and Maintenance # Deployment and Maintenance
## Puppet ## Puppet
...@@ -398,8 +385,6 @@ Telegraf collects statistics with input plugins. A list of plugins is [available ...@@ -398,8 +385,6 @@ Telegraf collects statistics with input plugins. A list of plugins is [available
## Release Management ## Release Management
# Code quality level for RDD # Code quality level for RDD
## Code Reviews ## Code Reviews
...@@ -422,13 +407,11 @@ The main idea is to invite all developers to a MR, at least 2 approvals needed f ...@@ -422,13 +407,11 @@ The main idea is to invite all developers to a MR, at least 2 approvals needed f
5. After the MR has been (dis)approved, the assignee removes his- or herself from the list of assignees. The MUST assignee informs the developer over the review being finished. 5. After the MR has been (dis)approved, the assignee removes his- or herself from the list of assignees. The MUST assignee informs the developer over the review being finished.
6. The developer merges her changes into the development branch. 6. The developer merges her changes into the development branch.
## Proof of Concept ## Proof of Concept
When preparing a proof of concept that is always labeled `poc`, a code review is When preparing a proof of concept that is always labeled `poc`, a code review is
not necessary. not necessary.
# Intellectual Property # Intellectual Property
## Licensing ## Licensing
...@@ -458,11 +441,12 @@ Maybe the `license-maven` plugin will help you. ...@@ -458,11 +441,12 @@ Maybe the `license-maven` plugin will help you.
> There are multiple statements embedded into the software product describing unrestricted rights and any conditions for use, including commercial and non-commercial use, and the recommended citation. The list of developers is embedded in the source code of the product, in the documentation, and in the expression of the software upon execution. The intellectual property rights statements are expressed in legal language, machine-readable code, and in concise statements in language that can be understood by laypersons, such as a pre-written, recognisable license. > There are multiple statements embedded into the software product describing unrestricted rights and any conditions for use, including commercial and non-commercial use, and the recommended citation. The list of developers is embedded in the source code of the product, in the documentation, and in the expression of the software upon execution. The intellectual property rights statements are expressed in legal language, machine-readable code, and in concise statements in language that can be understood by laypersons, such as a pre-written, recognisable license.
##### Actions to Be Taken in RDD ##### Actions to Be Taken in RDD
- see rdd-technical-reference for choosing the license - see rdd-technical-reference for choosing the license
- source code: use OSI approved licenses? (see https://opensource.org/licenses) (++TODO discuss in fe-develop++) (how to chose a license?: http://freesoftwaremagazine.com/articles/choosing_and_using_free_licenses_software_hardware_and_aesthetic_works/fig_choosing_license.jpg) - source code: use OSI approved licenses? (see <https://opensource.org/licenses)> (++TODO discuss in fe-develop++) (how to chose a license?: <http://freesoftwaremagazine.com/articles/choosing_and_using_free_licenses_software_hardware_and_aesthetic_works/fig_choosing_license.jpg)>
- assets: CC0? CC-BY-SA? (++TODO discuss in fe-develop++) - assets: CC0? CC-BY-SA? (++TODO discuss in fe-develop++)
- we reach SML5 by providing a license file on root level containing the license text (GPL wants its license text in a file called COPYING [see https://www.gnu.org/licenses/gpl-howto.de.html] other licenses use LICENSE) - we reach SML5 by providing a license file on root level containing the license text (GPL wants its license text in a file called COPYING [see <https://www.gnu.org/licenses/gpl-howto.de.html>] other licenses use LICENSE)
- if the license text is not contained in the license file, we provide the full license text in another file (++TODO++) (https://softdev4research.github.io/4OSS-lesson/03-use-license/index.html#add-a-licence-file-to-a-repository) - if the license text is not contained in the license file, we provide the full license text in another file (++TODO++) (<https://softdev4research.github.io/4OSS-lesson/03-use-license/index.html#add-a-licence-file-to-a-repository)>
- in the source code header the license statement is added to every file. GPL example: - in the source code header the license statement is added to every file. GPL example:
``` ```
...@@ -495,14 +479,14 @@ MUST be __SML3__: ...@@ -495,14 +479,14 @@ MUST be __SML3__:
„Use is possible by most users: Future extensibility is designed into the system for a moderate range of use cases. The procedures for extending the software are defined, whether by source code modification or through the provision of some type of extension functionality (e.g., callback hooks or scripting capabilities). Where source code modification is part of the extension plan, the software is well-structured, has a moderate to high level of cohesion, and has configuration elements clearly separated from logic and display elements.“ „Use is possible by most users: Future extensibility is designed into the system for a moderate range of use cases. The procedures for extending the software are defined, whether by source code modification or through the provision of some type of extension functionality (e.g., callback hooks or scripting capabilities). Where source code modification is part of the extension plan, the software is well-structured, has a moderate to high level of cohesion, and has configuration elements clearly separated from logic and display elements.“
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- Future extensibility is designed into the system - Future extensibility is designed into the system
- on RDD developer level - on RDD developer level
- source code modification --> software is well-structured - source code modification --> software is well-structured
- provision of some type of extension functionality --> use of frameworks such as templating engines and localization frameworks - provision of some type of extension functionality --> use of frameworks such as templating engines and localization frameworks
- configuration elements clearly separated from logic and display elements - configuration elements clearly separated from logic and display elements
- use SADE as example project - use SADE as example project
## CA4: Modularity ## CA4: Modularity
MUST be __SML3__: MUST be __SML3__:
...@@ -514,13 +498,13 @@ SHOULD be __SML5__: ...@@ -514,13 +498,13 @@ SHOULD be __SML5__:
„Demonstrable usability: It is evident that all functions and data are encapsulated into objects or accessible through web service interfaces. There is consistent error handling with meaningful messages and advice, and use of generic extensions to program languages for stronger type checking and compilation-time error checking. Services are available externally and code within each module contains few independent logical paths.“ „Demonstrable usability: It is evident that all functions and data are encapsulated into objects or accessible through web service interfaces. There is consistent error handling with meaningful messages and advice, and use of generic extensions to program languages for stronger type checking and compilation-time error checking. Services are available externally and code within each module contains few independent logical paths.“
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- we NEED consistent error handling with meaningful messages and advice - we NEED consistent error handling with meaningful messages and advice
- if specific errors can occur --> create explicit errors - if specific errors can occur --> create explicit errors
- return and input types must be defined if language allows types - return and input types must be defined if language allows types
- think of possible reuse of internal methods --> make them externally available - think of possible reuse of internal methods --> make them externally available
- one module serves one purpose - one module serves one purpose
## CA6: Portability ## CA6: Portability
(target platform: e.g. Docker container) (target platform: e.g. Docker container)
...@@ -530,11 +514,11 @@ MUST BE __SML5__: ...@@ -530,11 +514,11 @@ MUST BE __SML5__:
„Demonstrable usability: The software is completely portable to the target platform. In theory at least, the software will run on the target platform provided it is packaged/containerised.“ „Demonstrable usability: The software is completely portable to the target platform. In theory at least, the software will run on the target platform provided it is packaged/containerised.“
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- examples for target platforms: TextGridLab (Windows, Linux, Mac OS), Java Web Services (Web Application Server: Tomcat, etcpp), SADE (eXistDB, Linux, Windows), DiscussData-Django-App (jeder Host, für den Docker verfügbar ist) - examples for target platforms: TextGridLab (Windows, Linux, Mac OS), Java Web Services (Web Application Server: Tomcat, etcpp), SADE (eXistDB, Linux, Windows), DiscussData-Django-App (jeder Host, für den Docker verfügbar ist)
++ Michelle möchte, dass wir mehr über Docker sprechen! ++ ++ Michelle möchte, dass wir mehr über Docker sprechen! ++
## CA7: Standards Compliance ## CA7: Standards Compliance
MUST BE __SML3__: MUST BE __SML3__:
...@@ -542,63 +526,67 @@ MUST BE __SML3__: ...@@ -542,63 +526,67 @@ MUST BE __SML3__:
„Use is possible by most users: The software and software development process comply with open, recognised or proprietary standards, but there is incomplete verification of compliance. Compliance to recognised standards has be tested but this may not be for all components. There is documented evidence of standards being used, but not of the verification of components.“ „Use is possible by most users: The software and software development process comply with open, recognised or proprietary standards, but there is incomplete verification of compliance. Compliance to recognised standards has be tested but this may not be for all components. There is documented evidence of standards being used, but not of the verification of components.“
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- coding standards: code style, git (commit hooks), gitflow/gitlabflow, (semantic) versioning - coding standards: code style, git (commit hooks), gitflow/gitlabflow, (semantic) versioning
- software standards: documentation (JavaDoc, OpenAPI, etcpp), data and metadata formats, APIs (REST, SOAP, OAI-PMH, etcpp), license - software standards: documentation (JavaDoc, OpenAPI, etcpp), data and metadata formats, APIs (REST, SOAP, OAI-PMH, etcpp), license
- CI standards: release workflow (?), deployment - CI standards: release workflow (?), deployment
## CA8: Support ## CA8: Support
MUST BE __SML1__: MUST BE __SML1__:
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- an organizational e-mail-adress must be provided with the readme and in a convenient view, e.g. imprint/help/info etc. - an organizational e-mail-adress must be provided with the readme and in a convenient view, e.g. imprint/help/info etc.
SHOULD BE __SML3__: SHOULD BE __SML3__:
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- provide support "near" the source code (discussable) - provide support "near" the source code (discussable)
- by any means, provide it in *one* location - by any means, provide it in *one* location
- regular and planned releases - regular and planned releases
## CA9: Verification and Testing ## CA9: Verification and Testing
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- CESSDAs definitions seems a bit unclear to us - CESSDAs definitions seems a bit unclear to us
- without referencing the SMLs we link our test chapter to CESSDAs document - without referencing the SMLs we link our test chapter to CESSDAs document
## CA10: Security ## CA10: Security
MUST BE __SML2__: MUST BE __SML2__:
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- every developer must have had a basic security training - every developer must have had a basic security training
SHOULD BE __SML5__: SHOULD BE __SML5__:
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- address security in every step of development (design, implementation, testing and verification, release) - address security in every step of development (design, implementation, testing and verification, release)
__TODO__: __TODO__:
- mit AL über Training für alle Developer sprechen - mit AL über Training für alle Developer sprechen
- Anforderungen an Softwaresicherheit formulieren - Anforderungen an Softwaresicherheit formulieren
- Training erarbeiten (mit Security-Issue-Liste beginnen) - Training erarbeiten (mit Security-Issue-Liste beginnen)
## CA11: Internationalisation and Localisation ## CA11: Internationalisation and Localisation
MUST BE __SML1,5__ MUST BE __SML1,5__
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- locale awareness is a high requirement for software with a monolingual target audience but you must provide it in english (and/or the target language) at least - locale awareness is a high requirement for software with a monolingual target audience but you must provide it in english (and/or the target language) at least
SHOULD BE __SML3__ SHOULD BE __SML3__
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- if applicable, i18n and l10n frameworks should be used
nice to read: https://bridge360blog.com/2011/11/25/software-design-considerations-for-internationalization-and-localization/ - if applicable, i18n and l10n frameworks should be used
nice to read: <https://bridge360blog.com/2011/11/25/software-design-considerations-for-internationalization-and-localization/>
## CA12: Authentication and Authorisation ## CA12: Authentication and Authorisation
...@@ -608,16 +596,14 @@ SHOULD BE __SML4__ ...@@ -608,16 +596,14 @@ SHOULD BE __SML4__
In this case we cannot give a general recommendation since the way authentication and authorisation is implemented inherently depends on the software's functionality. Instead of developing an own solution rely on DARIAH's AAI whenever possible. In this case we cannot give a general recommendation since the way authentication and authorisation is implemented inherently depends on the software's functionality. Instead of developing an own solution rely on DARIAH's AAI whenever possible.
__Actions to Be Taken in RDD:__ __Actions to Be Taken in RDD:__
- never share passwords - never share passwords
- use Shibboleth whenever possible and reasonable - use Shibboleth whenever possible and reasonable
# Retirement of Software # Retirement of Software
- clarify if software is no longer supported - clarify if software is no longer supported
# Helpful Links and References # Helpful Links and References
- EURISE-network technical-reference:\ - EURISE-network technical-reference:\
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment