Skip to content

Add checklist topic; starting with the SciLifeLab Open Software Checklist#766

Draft
almanilsson wants to merge 13 commits into
mainfrom
open-software-checklist
Draft

Add checklist topic; starting with the SciLifeLab Open Software Checklist#766
almanilsson wants to merge 13 commits into
mainfrom
open-software-checklist

Conversation

@almanilsson

Copy link
Copy Markdown
Contributor

Summary

This PR adds the topic 'parent' called "Checklists" under which checklists can be reached via a dropdown like with the human data topics.
This PR aims to make the checklists more accessible in terms of:

  • visuals - communicating material
  • self assessment - click to check off items
  • Communication to others - generated README statement of compliance with checklist

It also adds the SciLifeLab Open Software Checklist as one of the children to the "Checklists" topic, thereby solving part of issue #655 (it does not add the Open Access Checklist though).

The checklist page includes

  • Collapsible checklist items which features:
    • Description
    • Explanation
    • Action
    • Tags for FAIR category
    • Tags for priority, coloured according to priority level
  • Tags for project size (big vs small code project)
  • Filtering on project size
  • Counter for number of checked items
  • Ability to copy a citation including the number of checked items
  • A citation of the resource on figshare

Note: Empty AI ready checklist is inlcuded to show dropdown, this should be removed before merging

Notes for Reviewers

  • Is the function and layout intuitive?
  • Is this the correct placement and parent topic name?
  • is the counter, priority level, sorting on big/small projects, and FAIR tags helpful and clear?
  • Should we change wording from "software" to "code"
  • Are descriptions, explanations and actions clear?

Checklist

  • PR title is a clear and short description
  • Related Github issue is linked
  • Assignee is selected
  • Automated checks pass

@almanilsson almanilsson self-assigned this Jun 24, 2026
@almanilsson almanilsson added the new content For issues where new content might be needed (not for MVP) label Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new content For issues where new content might be needed (not for MVP)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant