Skip to content

Commit 5cafa5a

Browse files
Added maintenance badge and reordered badge metadata fields
1 parent f46d485 commit 5cafa5a

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

src/doc/manifest.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -175,31 +175,28 @@ license = "..."
175175
# (similar to the readme key).
176176
license-file = "..."
177177

178-
# Optional specification of badges to be displayed on crates.io. The badges
179-
# currently available are Travis CI, Appveyor, and GitLab latest build status,
180-
# specified using the following parameters:
178+
# Optional specification of badges to be displayed on crates.io. The badges
179+
# pertaining to build status that are currently available are Appveyor, CircleCI,
180+
# GitLab, and TravisCI. Available badges pertaining to code test coverage are
181+
# Codecov and Coveralls. There are also maintenance-related badges which state
182+
# the issue resolution time, percent of open issues, and future maintenance
183+
# intentions.
181184
[badges]
182185

183-
# Travis CI: `repository` in format "<user>/<project>" is required.
184-
# `branch` is optional; default is `master`
185-
travis-ci = { repository = "...", branch = "master" }
186-
187186
# Appveyor: `repository` is required. `branch` is optional; default is `master`
188187
# `service` is optional; valid values are `github` (default), `bitbucket`, and
189188
# `gitlab`.
190189
appveyor = { repository = "...", branch = "master", service = "github" }
191190

192-
# GitLab: `repository` is required. `branch` is optional; default is `master`
193-
gitlab = { repository = "...", branch = "master" }
194-
195191
# Circle CI: `repository` is required. `branch` is optiona; default is `master`
196192
circle-ci = { repository = "...", branch = "master" }
197193

198-
# Is it maintained resolution time: `repository` is required.
199-
is-it-maintained-issue-resolution = { repository = "..." }
194+
# GitLab: `repository` is required. `branch` is optional; default is `master`
195+
gitlab = { repository = "...", branch = "master" }
200196

201-
# Is it maintained percentage of open issues: `repository` is required.
202-
is-it-maintained-open-issues = { repository = "..." }
197+
# Travis CI: `repository` in format "<user>/<project>" is required.
198+
# `branch` is optional; default is `master`
199+
travis-ci = { repository = "...", branch = "master" }
203200

204201
# Codecov: `repository` is required. `branch` is optional; default is `master`
205202
# `service` is optional; valid values are `github` (default), `bitbucket`, and
@@ -209,6 +206,18 @@ codecov = { repository = "...", branch = "master", service = "github" }
209206
# Coveralls: `repository` is required. `branch` is optional; default is `master`
210207
# `service` is optional; valid values are `github` (default) and `bitbucket`.
211208
coveralls = { repository = "...", branch = "master", service = "github" }
209+
210+
# Is it maintained resolution time: `repository` is required.
211+
is-it-maintained-issue-resolution = { repository = "..." }
212+
213+
# Is it maintained percentage of open issues: `repository` is required.
214+
is-it-maintained-open-issues = { repository = "..." }
215+
216+
# Maintenance: `status` is required Available options are `actively-developed`,
217+
# `passively-maintained`, `as-is`, `none`, `experimental`, `looking-for-maintainer`
218+
# and `deprecated`.
219+
maintenance = { status = "none" }
220+
212221
```
213222

214223
The [crates.io](https://crates.io) registry will render the description, display

0 commit comments

Comments
 (0)