Skip to content

fix: improve logic for existing README validation #325

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
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

fix: improve logic for existing README validation #325

wants to merge 8 commits into from

Conversation

Parkreiner
Copy link
Member

@Parkreiner Parkreiner commented Aug 13, 2025 •
edited
Loading

Addresses part of #194

Description

This PR beefs up the validation for the validation logic that we already had in place. This PR does not include adding validation for templates (which will be addressed in a second PR).

Changes made

  • Added logic to reject unknown frontmatter fields for modules and contributor profile README files
  • Added logic to handle frontmatter fields that were previously missed in validation steps (GitHub username for contributors and Operating Systems for modules)
  • Updated a few comments (added some new comments, formatted existing comments to meet 100-column width)

Type of Change

  • New module
  • Bug fix
  • Feature/enhancement
  • Documentation
  • Other

Testing & Validation

  • Tests pass (bun test)
  • Code formatted (bun run fmt)
  • Changes tested locally

@Parkreiner Parkreiner requested a review from cstyan August 13, 2025 01:10
@Parkreiner Parkreiner self-assigned this Aug 13, 2025
DevelopmentCats
DevelopmentCats approved these changes Aug 13, 2025
View reviewed changes
Copy link
Contributor

@DevelopmentCats DevelopmentCats left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Great! Ill wait for Atif to look at this before we merge it just in case he has some thoughts on other things we could validate here outside of template stuff like you mentioned.

@Parkreiner Parkreiner mentioned this pull request Aug 13, 2025
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DevelopmentCats DevelopmentCats DevelopmentCats approved these changes

@cstyan cstyan Awaiting requested review from cstyan

@matifali matifali Awaiting requested review from matifali

Assignees

@Parkreiner Parkreiner

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Parkreiner @DevelopmentCats