From d04a2c6a0142a822f13be35c07dd8e0032129bf2 Mon Sep 17 00:00:00 2001
From: Chris Wong <lambda.fairy@gmail.com>
Date: Sun, 10 Apr 2022 20:29:41 +1000
Subject: [PATCH] Document that the `doctest` crate might need updating (#338)
Also rename the "Examples" build to "Doctest" to clarify what it does.
---
.github/workflows/ci.yml | 4 ++--
CONTRIBUTING.md | 3 +++
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 375645f..1a64008 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 8f1ea61..a81571a 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