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

Warn if library has no Readme #1339

Open
vinniefalco opened this issue Oct 7, 2024 · 2 comments · May be fixed by #1350
Open

Warn if library has no Readme #1339

vinniefalco opened this issue Oct 7, 2024 · 2 comments · May be fixed by #1350

Comments

@vinniefalco
Copy link
Member

When a library does not have a README.md or README.adoc, the panel should still appear and there should be a message which urges the author or the visitor to contribute one:

"This library has no README.adoc, consider contributing one or send physical mail to the author at 1234 Lane Rd."

@GregKaleka GregKaleka linked a pull request Oct 9, 2024 that will close this issue
@GregKaleka
Copy link

I opened a small PR to handle this - open to feedback. I didn't include the physical address bit, since I'm not sure where that info would come from. I don't see any address fields on the library model, nor the User model (where we could grab it from the authors field).

Apologies if the "mail the README" bit is a joke and I'm taking it too seriously 😊.

@vinniefalco
Copy link
Member Author

The problem can be seen here:

image

In between the "This Release" and "All Time" should be a README card, even if there is no README file. And in this case where there is no file we should put up a big sign in flashing lights that says "pretty please...with a cherry on top... add a f'king readme"

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 a pull request may close this issue.

2 participants