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

Closed
carols10cents opened this Issue May 2, 2017 · 6 comments

Comments

Projects
None yet
3 participants
@carols10cents
Member

carols10cents commented May 2, 2017

Part of RFC 1824, rust-lang/rust#41616.

Add to the badges table in Cargo.toml a maintenance key that crate authors could use to
self-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:

Actively developed
New features are being added and bugs are being fixed.
Passively maintained
There are no plans for new features, but the maintainer intends to respond to issues that get filed.
As-is
The crate is feature complete, the maintainer does not intend to continue working on it or providing support, but it works for the purposes it was designed for.
none
We display nothing. Since the maintainer has not chosen to specify their intentions, potential crate users will need to investigate on their own.
Experimental
The author wants to share it with the community but is not intending to meet anyone's particular use case.
Looking for maintainer
The current maintainer would like to transfer the crate to someone else.
Deprecated
The maintainer does not recommend using this crate (the description of the crate can describe why, there could be a better solution available or there could be problems with the crate that the author does not want to fix) Added from a suggestion in #549

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!

@marti1125

This comment has been minimized.

Contributor

marti1125 commented May 16, 2017

Hi @carols10cents!! I would like to work on this

marti1125 added a commit to marti1125/crates.io that referenced this issue May 31, 2017

@marti1125

This comment has been minimized.

Contributor

marti1125 commented Jun 6, 2017

Hello @carols10cents I made list of tasks following the email

carols10cents added a commit to marti1125/crates.io that referenced this issue Jul 15, 2017

carols10cents added a commit that referenced this issue Jul 15, 2017

@vignesh-sankaran

This comment has been minimized.

Contributor

vignesh-sankaran commented Aug 12, 2017

@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?

@vignesh-sankaran

This comment has been minimized.

Contributor

vignesh-sankaran commented Aug 16, 2017

We also need to:

  • Fix up badge parsing in the crates.io backend. Cargo.toml requires the value to be a String, and cannot have the maintenance value as-is

EDIT: Turns out we don't need to do this since specifying the maintenance intention is done with snake-case :)

bors added a commit to rust-lang/cargo that referenced this issue Aug 24, 2017

Auto merge of #4431 - vignesh-sankaran:maintenance-badge-docs, r=alex…
…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.

bors-voyager bot added a commit that referenced this issue Aug 30, 2017

Merge #952
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.
@vignesh-sankaran

This comment has been minimized.

Contributor

vignesh-sankaran commented Sep 8, 2017

Could we close this issue @carols10cents? I think everything for this issue has been implemented.

@carols10cents

This comment has been minimized.

Member

carols10cents commented Sep 10, 2017

Sounds good!

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