Skip to content
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

Suggest generating test rustdocs while reading the guide. #1019

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Suggest generating test rustdocs while reading the guide. #1019

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
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ Reviewing them is possible via these options:

## Adding a new lint

If you haven't contributed lints before, consider running [`./scripts/regenerate_test_rustdocs.sh`](https://github.com/obi1kenobi/cargo-semver-checks/tree/main/scripts/regenerate_test_rustdocs.sh) while you read this guide. Its first run will take a few minutes, and it's necessary to make tests pass. So kick it off in the background while you get up to speed here.

### Background

Lints are written as queries for the `trustfall` ["query everything" engine](https://github.com/obi1kenobi/trustfall).
Expand Down
Loading