diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 375645f6..1a64008b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -61,8 +61,8 @@ jobs: - name: Check Clippy run: cd docs && cargo clippy --all-targets -- -D warnings - examples: - name: Examples + doctest: + name: Doctest runs-on: ubuntu-latest steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f1ea61e..a81571a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,13 @@ Great to see that you want to help out! Here are some tips for getting started: * Most contributions should include [tests] and a [changelog entry]. + * If you're adding or updating a web framework integration, you might need to update the [doctest crate]. + * Want to work on documentation? See the [docs readme] for advice on that. Have fun! ☺️ [tests]: maud/tests [changelog entry]: CHANGELOG.md +[doctest crate]: doctest/Cargo.toml [docs readme]: docs/README.md