Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
## Project Scope

This repository is for storing and maintaining the Research Quality Indicators of the [Research Software Quality Kit](https://github.com/EVERSE-ResearchSoftware/RSQKit)
This repository is aimed at defining and maintaining Research Software Quality and Project Health Indicators.

The research software quality and project health indicators are used in:
- The [Research Software Quality Kit](https://github.com/EVERSE-ResearchSoftware/RSQKit), for annotating task pages.
- The [TechRadar](), where tools helping measure or improve indicators are defined.
- The [Research Software Quality Pipelines](), which provide actions to assess the indicators of a given repository.
- The [DASHVerse]() dashboards, where they define what to visualize in a given tracked repository.

## Indicators

All indicators added or to be added must be defined somewhere else. Also, they must follow the [validation schema](https://github.com/EVERSE-ResearchSoftware/indicators/blob/main/tests/indicator_validation_schema.json)
## Indicator lifecycle

Only then, a reviewer will review it and decide whether or not it is properly defined
All indicators are grounded on existing literature, indicating the source they have been derived from. In order for an indicatod to be considered, it must follow the [validation schema](https://github.com/EVERSE-ResearchSoftware/indicators/blob/main/tests/indicator_validation_schema.json) be submitted through a pull request.

Only then, a reviewer will assess it and decide whether or not the indicator is properly defined according to the contribution guidelines.

Contribution guidelines are defined in [CONTRIBUTING.md](https://github.com/EVERSE-ResearchSoftware/indicators/blob/main/CONTRIBUTING.md)

Once an indicator is added, reviewers will propagate it through the other tools:
- Annotating the corresponding tasks in RSQKit.
- Adding the corresponding tools to the TechRadar.
- Improving the quality pipelines with open source tools required for assessing them.

Loading