-
Notifications
You must be signed in to change notification settings - Fork 18k
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
x/pkgsite: don't display README section if it is empty #40867
Comments
Instead of displaying no readme section, how about we autogenerate a readme section? I think it'll be more helpful. |
@ironbatshashank - what are your thoughts on what that would look like? |
I think if there was to be some auto generated content it would be a bit difficult: Pros
Cons
I would opt for just a simple box of placeholder text saying something like "Looks like this project doesn't have a readme yet" or something similar. It requires minimal work to implement and can't break. I've not contributed to a golang project before but I'd be up for learning the process of contributing after completing the contributing guide. |
Thanks for the input, @IamCathal! Let's go with that suggestion.
If you're interested in contributing this fix, let me know. Happy to help you get started and answer any questions in #pkgsite Slack. https://github.com/golang/pkgsite/blob/master/CONTRIBUTING.md#getting-started is a good starting point. |
I failed to get the DB setup about 4 times on my own and couldn't progress with this issue, thank you very much @rahulw for the help with the setup. |
Change https://golang.org/cl/252997 mentions this issue: |
If a package doesn't have a README, don't display it.
What did you do?
Visited https://pkg.go.dev/github.com/gnuy/subdivx-get@v0.0.0-20200818145511-51d3e492f137?tab=overview
What did you expect to see?
No README section:
What did you see instead?
An empty README section:
The text was updated successfully, but these errors were encountered: