Document that the doctest crate might need updating (#338)

Also rename the "Examples" build to "Doctest" to clarify what it does.
lambda-fairy · Apr 10, 2022 · d04a2c6 · d04a2c6
1 parent e6787cd
commit d04a2c6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git 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
@@ -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