Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Project - README analysis #182

Open
pylapp opened this issue Jan 6, 2025 · 0 comments
Open

Project - README analysis #182

pylapp opened this issue Jan 6, 2025 · 0 comments
Labels
enhancement New feature or request feature-new Enhancement for a new feature (which has not its GitHub label)

Comments

@pylapp
Copy link
Member

pylapp commented Jan 6, 2025

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
  • ...
@pylapp pylapp added enhancement New feature or request feature-new Enhancement for a new feature (which has not its GitHub label) labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request feature-new Enhancement for a new feature (which has not its GitHub label)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pylapp