Skip to content

Add description and repository fields to Cargo.toml#7

Merged
eholk merged 3 commits intomicrosoft:mainfrom
eholk:release-prep
Aug 10, 2022
Merged

Add description and repository fields to Cargo.toml#7
eholk merged 3 commits intomicrosoft:mainfrom
eholk:release-prep

Conversation

@eholk
Copy link
Copy Markdown
Contributor

@eholk eholk commented Aug 10, 2022

I'm getting ready to push our first release to crates.io and it'd be better if we had these fields set first.

@eholk eholk requested a review from daprilik August 10, 2022 23:06
@daprilik
Copy link
Copy Markdown
Contributor

Consider adding some more "advertising" fields as well (e.g: see gdbstub: https://github.com/daniel5151/gdbstub/blob/master/Cargo.toml#L8-L13)

@eholk
Copy link
Copy Markdown
Contributor Author

eholk commented Aug 10, 2022

Consider adding some more "advertising" fields as well (e.g: see gdbstub: https://github.com/daniel5151/gdbstub/blob/master/Cargo.toml#L8-L13)

Good idea, I added a few. Do you think there are any others I should add?

@eholk
Copy link
Copy Markdown
Contributor Author

eholk commented Aug 10, 2022

The documentation and readme fields get set to what we want by default, so I chose to leave those off.

@daprilik
Copy link
Copy Markdown
Contributor

daprilik commented Aug 10, 2022

The documentation and readme fields get set to what we want by default, so I chose to leave those off.

wait, whaaaat? since when??


Also - not entirely related to this PR - but consider adding some links (and/or badges) to the README.md that link to docs.rs/crates.io.

@eholk
Copy link
Copy Markdown
Contributor Author

eholk commented Aug 10, 2022

wait, whaaaat? since when??

Not sure, but here's the documentation: https://doc.rust-lang.org/cargo/reference/manifest.html#the-documentation-field

Also - not entirely related to this PR - but consider adding some links (and/or badges) to the README.md that link to docs.rs/crates.io.

Yeah, I think this would be good. I'll wait until we get the crate published so we actually have something to link to though :)

@daprilik
Copy link
Copy Markdown
Contributor

wait, whaaaat? since when??

Not sure, but here's the documentation: https://doc.rust-lang.org/cargo/reference/manifest.html#the-documentation-field

huh, the more you know.


I think this LGTM, feel free to send it 🚀

@eholk eholk merged commit 9ad60ec into microsoft:main Aug 10, 2022
@eholk eholk deleted the release-prep branch August 10, 2022 23:29
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 this pull request may close these issues.

2 participants