diff --git a/AGENTS.md b/AGENTS.md index f41507f..a274a0d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,6 +33,17 @@ line containing exactly three emoji relevant to the message context: `EMOJI EMOJI EMOJI` + +## No Emoji in Documentation + +Do not use emoji in documentation or README content, including headings, +prose, lists, and code comments. This applies to `README.md`, `AGENTS.md`, +and any other Markdown documentation in the repository. + +This does not apply to the Message Prefix and Message Suffix conventions +above, which require emoji in written agent communication. + + ## Embedded Fragments diff --git a/config/embedder.yml b/config/embedder.yml index 3b4e1f5..60cbcfe 100644 --- a/config/embedder.yml +++ b/config/embedder.yml @@ -34,6 +34,19 @@ fragments: `EMOJI EMOJI EMOJI` + no-emoji-in-docs: + path: AGENTS.md + content: | + + ## No Emoji in Documentation + + Do not use emoji in documentation or README content, including headings, + prose, lists, and code comments. This applies to `README.md`, `AGENTS.md`, + and any other Markdown documentation in the repository. + + This does not apply to the Message Prefix and Message Suffix conventions + above, which require emoji in written agent communication. + embedded-fragments: path: AGENTS.md content: | diff --git a/test/test_embedder_config.py b/test/test_embedder_config.py index 13128eb..1b78a47 100644 --- a/test/test_embedder_config.py +++ b/test/test_embedder_config.py @@ -23,10 +23,11 @@ def test_loads_embedder_config(self): self.assertEqual( set(fragments), - {"message-prefix", "message-suffix", "embedded-fragments", "dependabot"}, + {"message-prefix", "message-suffix", "no-emoji-in-docs", "embedded-fragments", "dependabot"}, ) self.assertEqual(fragments["message-prefix"].path, "AGENTS.md") self.assertEqual(fragments["message-suffix"].path, "AGENTS.md") + self.assertEqual(fragments["no-emoji-in-docs"].path, "AGENTS.md") self.assertEqual(fragments["embedded-fragments"].path, "AGENTS.md") def test_rejects_invalid_config(self):