Skip to content

feat: add no-emoji-in-docs AGENTS.md fragment #197

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

Merged
ineedjet merged 1 commit into from
Sep 2, 2026
Merged

feat: add no-emoji-in-docs AGENTS.md fragment #197

Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ line containing exactly three emoji relevant to the message context:
`EMOJI EMOJI EMOJI`
<!-- /baseline fragment: message-suffix -->

<!-- baseline fragment: no-emoji-in-docs -->
## 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.
<!-- /baseline fragment: no-emoji-in-docs -->

<!-- baseline fragment: embedded-fragments -->
## Embedded Fragments

Expand Down
13 changes: 13 additions & 0 deletions config/embedder.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ fragments:

`EMOJI EMOJI EMOJI`
<!-- /baseline fragment: message-suffix -->
no-emoji-in-docs:
path: AGENTS.md
content: |
<!-- baseline fragment: no-emoji-in-docs -->
## 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.
<!-- /baseline fragment: no-emoji-in-docs -->
embedded-fragments:
path: AGENTS.md
content: |
Expand Down
3 changes: 2 additions & 1 deletion test/test_embedder_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down