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

Add categories to Cargo.toml #498

Merged
merged 1 commit into from
Jan 23, 2017
Merged

Add categories to Cargo.toml #498

merged 1 commit into from
Jan 23, 2017

Conversation

shepmaster
Copy link
Contributor

Hi! crates.io now supports categories, which are a curated list
of topics aimed at helping an end-user coming to crates.io looking for
"a crate to do ______".

We're sending pull requests to selected crates to add categories in order to help
populate the categories and seed their usefulness. We've made a guess at the best
category/categories for this crate; if it doesn't fit, please feel free to take
a look at all the available categories and their descriptions and
the slug values that should be specified in your Cargo.toml and pick
different ones. If you have a category in mind that isn't available, you can
send a PR to this file on crates.io to propose additional
categories.

Crates can have up to 5 categories, and uploading categories to crates.io
currently requires publishing a new version with a cargo nightly from 2017-01-18
or later (it needs to contain this PR).

We've published a blog post with further details about categories.
The blog post also talks about the new crates.io support for CI badges, which
you may be interested in adding as well.

Please let me know if you have any questions!

@fiveop
Copy link
Contributor

fiveop commented Jan 20, 2017

Do older cargo versions ignore the categories in the toml, that is, is it backwards compatible?

@kamalmarhubi, @posborne I think the proposed category fits perfectly. I was thinking about addingos::macos-apis, but realised that we do not support MacOS-APIs, but *nix-APIs on MacOS.

@shepmaster
Copy link
Contributor Author

Do older cargo versions ignore the categories in the toml, that is, is it backwards compatible?

Yep! That's actually the reason you must have a new version of Cargo to publish categories. Cargo has a whitelist of properties that it sends to the crates.io server.

@fiveop
Copy link
Contributor

fiveop commented Jan 23, 2017

In that case

@homu r+

Thank you

@homu
Copy link
Contributor

homu commented Jan 23, 2017

📌 Commit ac57d53 has been approved by fiveop

@homu
Copy link
Contributor

homu commented Jan 23, 2017

⚡ Test exempted - status

@homu homu merged commit ac57d53 into nix-rust:master Jan 23, 2017
homu added a commit that referenced this pull request Jan 23, 2017
Add categories to Cargo.toml

Hi! [crates.io now supports categories][categories], which are a curated list
of topics aimed at helping an end-user coming to crates.io looking for
"a crate to do ______".

We're sending pull requests to selected crates to add categories in order to help
populate the categories and seed their usefulness. We've made a guess at the best
category/categories for this crate; if it doesn't fit, please feel free to take
a look at [all the available categories and their descriptions][categories] and
[the slug values that should be specified in your Cargo.toml][slugs] and pick
different ones. If you have a category in mind that isn't available, you can
[send a PR to this file on crates.io][categories.toml] to propose additional
categories.

Crates can have up to 5 categories, and uploading categories to crates.io
currently requires publishing a new version with a cargo nightly from 2017-01-18
or later (it needs to contain [this PR][cargo-pr]).

We've [published a blog post][blog-post] with further details about categories.
The blog post also talks about the new crates.io support for CI badges, which
you may be interested in adding as well.

Please let me know if you have any questions!

[categories]: https://crates.io/categories
[slugs]: https://crates.io/category_slugs
[categories.toml]: https://github.com/rust-lang/crates.io/blob/master/src/categories.toml
[cargo-pr]: rust-lang/cargo#3301
[blog-post]: http://integer32.com/2017/01/20/categories-and-ci-badges.html
@shepmaster shepmaster deleted the patch-1 branch January 23, 2017 14:46
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.

3 participants