Skip to content

Conversation

@JacobKnickerbocker
Copy link

@JacobKnickerbocker JacobKnickerbocker commented Oct 30, 2025

Description

I added a description to the beginning of the README for newcomers who may not necessarily understand what this project is. I made an issue (#2679 ) to describe this as well.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as before)

Checklist

  • Read the Contributing Guide
  • Perform a code self-review
  • Comment the code, particularly in hard-to-understand areas
  • Add documentation
  • Add hook's story at Storybook
  • Cover changes with tests
  • Ensure the test suite passes (yarn test)
  • Provide 100% tests coverage
  • Make sure code lints (yarn lint). Fix it with yarn lint:fix in case of failure.
  • Make sure types are fine (yarn lint:types).

@JacobKnickerbocker JacobKnickerbocker changed the title Add Brief Description to Start of README Feat: Add Brief Description to Start of README Oct 30, 2025
@JacobKnickerbocker JacobKnickerbocker changed the title Feat: Add Brief Description to Start of README feat: Add Brief Description to Start of README Oct 30, 2025
@JacobKnickerbocker
Copy link
Author

@streamich Just letting you know this is here! No rush!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant