-
Notifications
You must be signed in to change notification settings - Fork 605
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 a badge for crate authors to self-report their maintenance intentions #704
Comments
Hi @carols10cents!! I would like to work on this |
Hello @carols10cents I made list of tasks following the email
|
@carols10cents How do we want the maintenance intention badges to look like? Did we want it to look like the CI badges e.g. TravisCI? |
We also need to:
EDIT: Turns out we don't need to do this since specifying the maintenance intention is done with snake-case :) |
…crichton Add maintenance badge docs Pending merging of [this PR for crates.io](rust-lang/crates.io#952). This should close off [#704 on crates.io](rust-lang/crates.io#704). I've also updated the badge metadata docs and reordered the fields into groups by build, code coverage, and maintenance. So I've decided to put the list of possible badge options in the documentation, we'll have to find another place to put more detailed descriptions of the available maintenance badges.
952: Maintenence badge front end r=carols10cents Start front end work for #704 by creating a maintenance badge component. I'm not quite sure what the alias() function does in ember.js, think it takes out the attributes from the badges for a crate? I'm going to work on all the frontend changes here, since the tests failed when I attempted to add the fixture without the badge component. NOTE: If #996 is approved, I'll have to change this PR to work with it.
Could we close this issue @carols10cents? I think everything for this issue has been implemented. |
Sounds good! |
Improved docs for `maintenance` options I thought the lack of clear meanings for the available options could use some improvement. Basically an upgrade of #4431. Got the relevant text from rust-lang/crates.io#704 and the corresponding [rfc](https://github.com/rust-lang/rfcs/blob/master/text/1824-crates.io-default-ranking.md) *Questions* 1. Should I put the descriptions outside of the code block? 2. I copied the wording including "maintainer" and "author", should I replace it with "you" or something more appropriate?
Part of RFC 1824, rust-lang/rust#41616.
Add to the
badges
table inCargo.toml
amaintenance
key that crate authors could use toself-report their maintenance intentions. The valid values would be along the
lines of the following, and would influence the ranking in the order they're
presented:
These would be displayed as badges on lists of crates.
These levels would not have any time commitments attached to them-- maintainers
who would like to batch changes into releases every 6 months could report
"actively developed" just as much as mantainers who like to release every 6
weeks. This would need to be clearly communicated to set crate user
expectations properly.
This is also inherently a crate author's statement of current intentions, which
may get out of sync with the reality of the crate's maintenance over time.
Also need to update the documentation that currently lives in cargo's repo.
Please let me know if you have any questions, potential implementers!
The text was updated successfully, but these errors were encountered: