Project Checklist

[ciyer]

Stories

• As a project maintainer, I want Renku to help me ensure that I am following best practices and using Renku's capabilities to their fullest
• As a user, I want to look for projects that follow best practices because they will server as good examples and be more likely to have things that can be reused

Details

Project Checklist

The RenkuLab UI should check if the following things are fulfilled:

• Have a README.md (not default)
• Project has a marquee image
• Project has a license
• Project has datasets
• Datasets have marquee images
• Datasets have a license
• Datasets have a description
• Project has workflows

Checklist used in search

Search results should be scored according to project checklist. Entities that fulfill the points above should be shown earlier In the list of results.

The purpose of the Renku score is to increase the visibility of active, interesting content. What makes an entity interesting depends on its type.

Project

• Has the README been modified or is it the auto-generated one? A project with a user-provided readme should have higher visibility.
• Has a project image been set? A project with an image should have higher visibility.
• Has the project been changed recently? An active project should have higher visibility.
• Projects with datasets and workflows should have higher visibility.
• Projects with issues should have higher visibility
• Projects with merge requests should have higher visibility
• Projects with apps should have higher visibility

Dataset

• The more descendants a dataset has, the higher its score should be
• A dataset that is used in a workflow should have a higher score
• The more projects a dataset is used in, the higher its score should be

Workflows

• [need to define the score for workflows]