Skip to content

Document the approach to adding badges #193

@nathanjmcdougall

Description

@nathanjmcdougall

Motivation
If someone does usethis tool ruff does that mean they'll want the ruff badge too? Some users might find this is simply clutter.

So it could be opt-in with a flag. Or perhaps it could be opt-out.

Another option is to make it convenient to add all badges with a usethis badge all or generic usethis badge command.

In some cases like #122, I think I would definitely err on the side of including the badge. Whereas for something like pre-commit or uv, it seems like it might be viewed as cruft. Perhaps the distinction is that in the one case it's giving you the category of something (the development status) whereas for the others it's just telling you that a tool is being used. So by the same rationale, a License badge (#192) would be good to include by default when a license is selected.

I think it's fine for there to be variability in the defaults of whether a badge is included or not. So I like this approach - include a badge if it contains information beyond just that a tool is being used.

Summary of desired enhancement
Document this decision.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions