Skip to content

Add basic warnings to summarize on validate #4

@rak3rman

Description

@rak3rman

The validate script only ensures that each JSON object of summarize data matches its schema. Add a new feature to the summarize tool that will throw "warnings" whenever validate script is run. These warnings can be grammatical in nature and should block Github Actions checks from passing.

A few ideas for what warnings can be thrown:

  • Ensure that each object with bullets contains a certain percentage of quantitative metrics (i.e. 60% of bullets must contain a number)
  • Ensure that naming conventions are standard for numbers (i.e. can only use "10+" instead of "10's")
  • Check for basic grammatical errors (maybe add a dictionary of unique words that should NOT throw, i.e. "SpaceX")

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions