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.

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

findReadMe versitility #40

Open
1 task
AchillesHeir opened this issue Sep 13, 2024 · 0 comments
Open
1 task

findReadMe versitility #40

AchillesHeir opened this issue Sep 13, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@AchillesHeir
Copy link
Contributor

Description

The findReadMe functionality is super dynamic. In the extension results panel, there is a button that displays the extension's description. It works maybe 80-90 percent of the time, however, sometimes it's grabbing the wrong paragraph or hyperlinks displayed before the description.

Reproduction

https://github.com/oslabs-beta/SusCode/blob/main/src/workers/findReadMe.ts

System information

Not Applicable

Additional information

The overall issue with dynamism is that so many ReadMe formats are different. Different extensions will write there description in different places and label it differently or sometimes do not have a description at all. I think the functionality can be more dynamic than it is now, but making it foolproof is extremely difficult.

👨‍👧‍👦 Contributing

  • 🙋‍♂️ Yes, I'd love to make a PR to fix this bug!
@AchillesHeir AchillesHeir added the bug Something isn't working label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant