Skip to content

Commit 36a32e7

Browse files
authored
Merge pull request #43 from adambullmer/ai-agent-discoverability-12131984314782127933
✨ feat: Add AI agent discoverability configuration files
2 parents 57499f3 + 2b6f965 commit 36a32e7

9 files changed

Lines changed: 42 additions & 3 deletions

File tree

.cursorrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

.gemini/GEMINI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../AGENTS.md
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"name": "semantic-commit-emoji",
3+
"description": "Guidelines and style rules for authoring semantic commit messages with emojis, and instructions for staging and splitting commits deterministically.",
4+
"version": "1.0.0",
5+
"instructions": "Review the semantic-commit-emoji skill instructions located at .github/skills/semantic-commit-emoji/SKILL.md before creating commits or staging and splitting commits."
6+
}

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../AGENTS.md

SKILL.md renamed to .github/skills/semantic-commit-emoji/SKILL.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: semantic-commit-emoji
3+
description: Guidelines and style rules for authoring semantic commit messages with emojis, and instructions for staging and splitting commits deterministically.
4+
---
5+
16
# semantic-commit-emoji
27

38
This skill provides guidelines and style rules for authoring commit messages using the `semantic-commit-emoji` convention.
@@ -7,15 +12,15 @@ This convention builds upon the original Conventional Commits specification by a
712

813
As an AI agent, you should read and refer to the following extended documents based on these specific conditions:
914

10-
- **[Conventional Commits Spec](./skills/reference/conventional-commits.md)**
15+
- **[Conventional Commits Spec](../../../skills/reference/conventional-commits.md)**
1116
- Read this if you are unfamiliar with the foundational structure of a conventional commit (e.g., `<type>[optional scope]: <description>`).
1217
- Read this if you need to understand how to correctly format a `BREAKING CHANGE` footer or body.
1318

14-
- **[semantic-commit-emoji Style Rules](./skills/reference/semantic-commit-emoji-style.md)**
19+
- **[semantic-commit-emoji Style Rules](../../../skills/reference/semantic-commit-emoji-style.md)**
1520
- Read this **every time** you are preparing to write a commit message to ensure you select the correct commit `<type>` and corresponding emoji.
1621
- Read this if you need guidance on subject casing, motivation bodies, or issue referencing specific to this project's style.
1722

18-
- **[Staging and Splitting Commits](./skills/reference/staging-and-splitting.md)**
23+
- **[Staging and Splitting Commits](../../../skills/reference/staging-and-splitting.md)**
1924
- Read this if you have modified multiple files or made multiple distinct types of changes (e.g., a bug fix and a refactor) and need to create atomic commits.
2025
- Read this if you need to understand the deterministic order for staging commits.
2126
- Read this if you need to split changes within a single file using `git add -p`.

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Agent Instructions
2+
3+
This repository uses the `semantic-commit-emoji` convention for committing code, as well as specific rules for staging and splitting commits.
4+
5+
Whenever you are about to create a commit, or stage and split commits, you MUST first review the `semantic-commit-emoji` skill instructions.
6+
7+
The skill instructions are located at: `.github/skills/semantic-commit-emoji/SKILL.md`

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

GEMINI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,22 @@ The list of current message types and their used emoji
4949
| chore | :wrench: `:wrench:` |
5050
| types | :label: `:label:` |
5151

52+
## AI Agent Discoverability
53+
54+
If you are using AI agents like Claude, Cursor, GitHub Copilot, or Gemini, this repository includes built-in configurations that allow these tools to discover and automatically adhere to the `semantic-commit-emoji` convention.
55+
56+
By cloning or referencing this repository's configurations, your AI assistants will automatically read the canonical skill file located at `.github/skills/semantic-commit-emoji/SKILL.md` when preparing commits.
57+
58+
The following agents are natively supported:
59+
60+
- **GitHub Copilot**: Uses `.github/copilot-instructions.md`
61+
- **Cursor**: Uses `.cursorrules`
62+
- **Claude / Claude Code**: Uses `CLAUDE.md`
63+
- **Gemini**: Uses `GEMINI.md`, `.gemini/GEMINI.md`, and is registered as a CLI extension via `.gemini/extensions/semantic-commit-emoji/gemini-extension.json`
64+
- **Generic Agents**: Uses standard `AGENTS.md`
65+
66+
No further action is required; once your AI agent is operating within the workspace directory, these files automatically steer its commit messages into full compliance with `semantic-commit-emoji`.
67+
5268
## Installation
5369

5470
This can either be a global module if this is just a personal preference, or a project one, so that you may enforce consistency on all contributors.

0 commit comments

Comments
 (0)