Skip to content

Project - README analysis #182

Open
Open
@pylapp

Description

@pylapp

Story

As a forge admin,
I want a tool to check if README is compliant for each project in the organization
So that I can help projects to improve their README

Details

See for example this awesome Advent of Open Source page

Things to check (using regexp for example):

  • mention to license
  • badges (versions, license, code size, open issues, maintained or not)
  • reference to documentation
  • dependency graph
  • all contributors page
  • ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestfeature-newEnhancement for a new feature (which has not its GitHub label)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions