metadata: add repository

rust-cli / human-panic

Panic messages for humans.

https://docs.rs/human-panic

Apache License 2.0

1.66k stars 65 forks source link

metadata: add repository #45

Closed mathstuf closed 5 years ago

mathstuf commented 6 years ago

Cargo guidelines are to not set a homepage if it isn't any different than the repository URL. This causes the report to not have any link back to file an issue. If the repository is available, print it as well.

Note that I've tried to find a reference to the "don't set homepage if it isn't the same" guideline, but haven't found it yet.

The environment variable is not available yet. See https://github.com/rust-lang/cargo/pull/6096

Choose one: is this a 🙋 feature?

Checklist

[x] tests pass
[x] documentation is changed or added

Context

None

Semver Changes

Major; the Metadata structure has a new field that isn't specified in existing code.

mathstuf commented 6 years ago

Understood, but how about this instead:

Open an issue to do this for 2.0 (to keep a tracker on it);
Use CARGO_PKG_REPOSITORY for Homepage: if CARGO_PKG_HOMEPAGE is empty (possibly with a note about it being the repository).

mathstuf commented 6 years ago

making sure developers are aware that the homepage should be a good place to both find ways to report issues as well as general information about the app they're using.

That's fine if I have one, but all I have is a repository (hence this change) :) .

spacekookie commented 6 years ago

Yea but at that point you have the option of making a Github landing page or making the README friendly enough to read for non-developers. At least that's how I've been handling it for now.

I'm not opposed to a 2.0 tracking issue where this PR might eventually land, although I doubt there's gonna be enough new rationale to warrant ever doing a 2.0 (my co-maintainers might disagree with me here :wink:)

mathstuf commented 5 years ago

Done. Looks like the CI needs to bump to testing 1.31 as the minimum version is effectively that based on dependencies :/ .