rseng-quality-framework

Solid

The entry point and router for this pack: explains the research software quality framework - community-standard quality dimensions, measurable indicators and the three-tier model (analysis code, prototype tools, infrastructure) - and routes to the right companion rseng-* skill. Use PROACTIVELY at the start of any research software task to classify the software's tier and select which practices apply, and whenever the user asks what research software quality means, mentions quality dimensions, indicators or the three-tier model, wants a quality assessment or improvement plan for research software, or is unsure which quality practice to start with.

AI & Automation 14 stars 2 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Research software quality framework This skill is the entry point to the pack. It explains a community-standard framing of research software quality and points to the specialised sibling skills for concrete tasks. Ground every quality discussion in two questions: what tier of software is this, and which quality dimensions matter for it right now. ## The three-tier view Classify the software before recommending practices; expectations scale with intent, not with code size. - Tier 1, analysis code: scripts and notebooks capturing a computational method for a paper or dataset, often single-author. Quality floor: version control, a README stating purpose and how to run, a pinned environment, a license, and a citation entry. - Tier 2, prototype tools: software demonstrating a method for use beyond its origin project, multiple users or contributors. Add: tests with CI, structured documentation, releases with versioning, contribution notes. - Tier 3, research software infrastructure: services, libraries and frameworks that communities depend on. Add: governance, review process, security and maintenance policy, sustainability planning, archiving. Software moves between tiers; when analysis code starts being reused, recommend upgrading its practices tier by tier rather than all at once. ## Quality dimensions The framework defines 13 quality dimensions, formally published as a JSON-LD registry (https://w3id.org/everse/rsqd). Always take names and counts from the ...

Details

Author
fdiblen
Repository
fdiblen/rseng-agent-skills
Created
4 days ago
Last Updated
4 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Solid

rseng-code-quality

Covers writing readable research code and structuring software projects: naming, formatting, style guides, linters and formatters, pre-commit hooks, modular design, and a conventional directory layout with top-level metadata files. Use when the user asks how to make code readable or clean, pick or enforce a style guide, set up linting/formatting or pre-commit, name variables and functions, organise a repo, or decide where files and data go. For generating a new project from a maintained template see rseng-project-scaffolding; for quantitative complexity and duplication measurement see rseng-software-metrics; for architecture-level structure see rseng-software-design.

14 Updated 4 days ago
fdiblen
AI & Automation Solid

rseng-fair-software

Covers how to apply the FAIR principles - findable, accessible, interoperable, reusable - to research software, and how to assess a project's FAIRness. Use when the user asks how to make software FAIR, wants help with findability, discoverability, or software reuse, mentions metadata, persistent identifiers, DOIs, registries, or software citation in a FAIR context, or asks to run a FAIR self-assessment or checklist on a repository. (Automated FAIR4RS scoring, compliance levels and CI gates with the FAIRGuard tool are rseng-fairguard; FAIR for ML models and datasets is rseng-fair-ml; finding existing software to reuse is rseng-software-reuse.)

14 Updated 4 days ago
fdiblen
Code & Development Solid

rseng-management-planning

Covers planning research software work: writing and maintaining a Software Management Plan (SMP), and choosing programming languages, tools, and infrastructures for a project. Use when the user wants to write or review an SMP, plan how software will be developed, maintained, shared, and preserved, needs the software sections of a proposal or funder template, wants to decide which language or framework to start a project in (Python, C++, R, Julia, Rust, Fortran, JavaScript), pick a project template or boilerplate, or weigh reuse, sustainability, and funder requirements at the start of a project. (Data management plans, maDMPs, DS-Wizard and DMPonline are rseng-data-management-plans; interactive new-project setup is rseng-project-kickoff; week-to-week task tracking is rseng-project-tracking.)

14 Updated 4 days ago
fdiblen