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

Does every crate need a homepage? #26

Closed
dtolnay opened this issue Apr 4, 2017 · 4 comments
Closed

Does every crate need a homepage? #26

dtolnay opened this issue Apr 4, 2017 · 4 comments

Comments

@dtolnay
Copy link
Member

dtolnay commented Apr 4, 2017

The current guideline says:

Cargo.toml includes all common headers (C-CARGO-HEADERS)
\ authors, description, documentation, homepage, repository, readme, keywords, categories, license

Does something like lazy_static need a "homepage"? Here are two points of view:

  • NO!

    The crates.io page already links to "repository" and "documentation." For something like lazy_static that should be all you need.

  • YES!

    The "homepage" is the thing that we want people to link to when discussing a particular crate. For example in a blog post about Serde we would want them to link to https://serde.rs which is the homepage for Serde. We would not want them to link to crates.io or the repository or the rustdoc because those are not our preferred landing page for new users.

    Simpler crates like lazy_static should choose one of crates.io, repository, or rustdoc as their preferred landing page for new users and set that as the homepage.

@Razican
Copy link

Razican commented Apr 12, 2017

I think a crate should have a homepage if it actually have a homepage about it. Crates.io is not a homepage for any crate, it's a place where you can find crates. If you are already on the crate page, you don't need a link to itself. Rustdoc is documentation, and there is already a documentation keyword for it. And finally, GitHub is the repo, and you already have a keyword for it.

I have found myself clicking homepage in a crate thinking I would find a cool homepage, even a forum or some information about the crate and finally arriving to the GitHub repo in a repeated link.

So for my, the answer is no, lazy_static does not need a homepage. Nevertheless, if somebody creates a whole website about lazy_static, then it should be included in the TOML.

@brson
Copy link
Contributor

brson commented Jun 30, 2017

Add to existing guideline about crates.io metadata.

@brson
Copy link
Contributor

brson commented Jul 6, 2017

Let's only add 'homepage' when there's an actual homepage seperate from the doc and repo.

@lambda
Copy link

lambda commented Jul 7, 2017

I find it frustrating when crates list a homepage that is just a duplicate of the link to the docs or to the repository. It takes more time for me to explore to see where to find more information about the crate.

I think the guideline should be updated to explicitly mention this, and request removal of a redundant homepage link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants