Skip to content

Document how to add new badge implementations #1081

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.

Sign up for GitHub

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

Merged
nathanjmcdougall merged 1 commit into from
Nov 4, 2025
Merged

Document how to add new badge implementations #1081

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,24 @@ in `pyproject.toml` to understand the structure of the project.

To ensure the `--quiet` flag is always effective, avoid using simple `print` statements.
Instead, use the purpose-built `usethis._console.plain_print` function.

## Guides

### Adding a new badge

To add a new `usethis badge` interface, follow these steps:

- Define a `get_<badge_name>_badge` function in <src\usethis\_core\badge.py>. Try to
keep the definitions in alphabetical order.
- Declare the interface in <src\usethis\_ui\interface\badge.py>. Again, keep the
declarations in alphabetical order. The pattern is basically just boilerplate with
the other interfaces, but you need to give a description of your command for the
`--help` option.
- Add a test for your badge in <tests\usethis\_ui\interface\test_interface_badge.py>.
Follow the pattern of the existing tests, although you only need the `test_add` case,
which simply tests that the command runs without error.
- Declare a recommended badge placement in the `get_badge_order` function in
<src\usethis\_core\badge.py>. This helps ensure the badges are arranged in an
opinionated way relative to existing badges.

Finally, run the command on this project, to make sure the badge gets inserted correctly with valid Markdown syntax. Check it renders successfully and that any hyperlink works as expected.