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

Jump to bottom

x/pkgsite: README.tmpl preferred over README.md #43314

Closed
mmcloughlin opened this issue Dec 22, 2020 · 3 comments
Closed

x/pkgsite: README.tmpl preferred over README.md #43314

mmcloughlin opened this issue Dec 22, 2020 · 3 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Milestone
pkgsite/unplanned

Comments

@mmcloughlin
Copy link
Contributor

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/mmcloughlin/geohash

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36

Screenshot

Screen Shot 2020-12-21 at 8 45 30 PM

What did you do?

Visit package overview page for https://github.com/mmcloughlin/geohash

What did you expect to see?

README.md displayed as the README section.

What did you see instead?

README.tmpl is shown instead. This is a template for the README.md file. I can certainly rename or move the template, but this still seems like it might be an error in the readme selection code.
@gopherbot gopherbot added this to the Unreleased milestone Dec 22, 2020
@mmcloughlin
Copy link
Contributor Author

I should say I'm perfectly happy for this issue to be closed with "your repository is stupid, please rename your README.tmpl file" 😆

At the same time I imagine there are a whole load of edge cases like this across the universe of Go modules, and it could help to implement a "readme preference list" sort of thing.

@julieqiu julieqiu added the NeedsFix The path to resolution is known, but the work has not been done. label Dec 23, 2020
@gopherbot
Copy link

Change https://golang.org/cl/279812 mentions this issue: internal/fetch: prefer readmes in markdown

@mmcloughlin
Copy link
Contributor Author

Thanks for fixing this so quickly!

@golang golang locked and limited conversation to collaborators Jan 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Projects
None yet
Milestone
pkgsite/unplanned
Development

No branches or pull requests
3 participants
@julieqiu @mmcloughlin @gopherbot