EddieHubCommunity / RepoRater

Rate GitHub Repos for Developer Experience (DX)
https://repo-rater.eddiehub.org
MIT License
154 stars 36 forks source link

Enhance component with type checking and documentation #96

Open coderabbitai[bot] opened 9 months ago

coderabbitai[bot] commented 9 months ago

The component now includes a parameter that contains details such as the owner and repository name. This parameter is also used for applying styling to the repository name in toast notifications. To maintain code quality and provide clear expectations for future contributors, it's suggested to document the structure of the parameter and introduce type checking to ensure the object passed has the necessary properties. This issue tracks the enhancement for type checking and documentation of the parameter in the component.

Related PR: https://github.com/EddieHubCommunity/RepoRater/pull/95 Related comment: https://github.com/EddieHubCommunity/RepoRater/pull/95#discussion_r1443927128

cc @amanr-dev