Skip to content

Commit ea0cd03

Browse files
jdfalkjdfalk
committed
Refactor documentation and workflows for improved clarity and organization
- Updated AGENTS.md, CLAUDE.md, and README.md to centralize AI agent instructions. - Enhanced general coding instructions in general-coding.instructions.md with clearer formatting. - Revised individual language instructions (Go, JavaScript, Python, etc.) to standardize file paths and descriptions. - Improved workflow YAML files for better readability and consistency in syntax. - Fixed circular reference in issue management workflow to ensure proper processing of issue updates. - Updated various prompts for AI tasks to include clearer guidelines and formatting. - Corrected minor formatting issues across multiple documentation files for consistency. Signed-off-by: Johnathan Falk <johnathan.falk@gmail.com>
1 parent f4b42c1 commit ea0cd03

47 files changed

Lines changed: 174 additions & 96 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- file: .github/AGENTS.md -->
2+
23
# AGENTS.md
34

45
> **NOTE:** This file is a pointer. All Copilot/AI agent and workflow instructions are now centralized in the `.github/instructions/` and `.github/prompts/` directories.

‎.github/CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- file: .github/CLAUDE.md -->
2+
23
# CLAUDE.md
34

45
> **NOTE:** This file is a pointer. All Claude/AI agent and workflow instructions are now centralized in the `.github/instructions/` and `.github/prompts/` directories.

‎.github/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- file: .github/README.md -->
2+
23
# Copilot/AI Agent Coding Instructions System
34

45
This repository uses a centralized, modular system for Copilot/AI agent coding, documentation, and workflow instructions, following the latest VS Code Copilot customization best practices.

‎.github/copilot-instructions.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- file: .github/copilot-instructions.md -->
2+
23
# Copilot/AI Agent Coding Instructions System
34

45
This repository uses a centralized, modular system for Copilot/AI agent coding, documentation, and workflow instructions, following the latest VS Code Copilot customization best practices.

‎.github/instructions/general-coding.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
<!-- file: .github/instructions/general-coding.instructions.md -->
2-
---
3-
applyTo: "**"
1+
## <!-- file: .github/instructions/general-coding.instructions.md -->
2+
3+
applyTo: "\*\*"
44
description: |
5-
General coding, documentation, and workflow rules for all Copilot/AI agents and VS Code Copilot customization. These rules apply to all files and languages unless overridden by a more specific instructions file. For details, see the main documentation in `.github/copilot-instructions.md`.
5+
General coding, documentation, and workflow rules for all Copilot/AI agents and VS Code Copilot customization. These rules apply to all files and languages unless overridden by a more specific instructions file. For details, see the main documentation in `.github/copilot-instructions.md`.
6+
67
---
78

89
# General Coding Instructions
@@ -22,6 +23,7 @@ For more details and the full system, see [copilot-instructions.md](../copilot-i
2223
## Required File Header (File Identification)
2324

2425
All source, script, and documentation files MUST begin with a standard header containing:
26+
2527
- The exact relative file path from the repository root (e.g., `# file: path/to/file.py`)
2628
- The file's semantic version (e.g., `# version: 1.0.0`)
2729
- The file's GUID (e.g., `# guid: 123e4567-e89b-12d3-a456-426614174000`)

‎.github/instructions/github-actions.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- file: .github/instructions/github-actions.instructions.md -->
22
<!-- version: 1.0.0 -->
3-
<!-- guid: 9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f -->
4-
---
5-
applyTo: ".github/workflows/*.{yml,yaml}"
3+
4+
## <!-- guid: 9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f -->
5+
6+
applyTo: ".github/workflows/\*.{yml,yaml}"
67
description: |
7-
Coding, documentation, and workflow rules for GitHub Actions workflow files, following Google and project-specific style guides. Reference the general instructions for all Copilot/AI agents and VS Code Copilot customization. For details, see the main documentation in `.github/copilot-instructions.md`.
8+
Coding, documentation, and workflow rules for GitHub Actions workflow files, following Google and project-specific style guides. Reference the general instructions for all Copilot/AI agents and VS Code Copilot customization. For details, see the main documentation in `.github/copilot-instructions.md`.
9+
810
---
911

1012
# GitHub Actions Workflow Coding Instructions

‎.github/instructions/go.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- file: .github/instructions/go.instructions.md -->
22
<!-- version: 1.0.0 -->
3-
<!-- guid: 8f4g3c5d-6e7b-5d9f-0a1b-2c3d4e5f6g7h -->
4-
---
5-
applyTo: "**/*.go"
3+
4+
## <!-- guid: 8f4g3c5d-6e7b-5d9f-0a1b-2c3d4e5f6g7h -->
5+
6+
applyTo: "\*_/_.go"
67
description: |
7-
Go language-specific coding, documentation, and testing rules for Copilot/AI agents and VS Code Copilot customization. These rules extend the general instructions in `general-coding.instructions.md` and merge all unique content from the Google Go Style Guide.
8+
Go language-specific coding, documentation, and testing rules for Copilot/AI agents and VS Code Copilot customization. These rules extend the general instructions in `general-coding.instructions.md` and merge all unique content from the Google Go Style Guide.
9+
810
---
911

1012
# Go Coding Instructions

‎.github/instructions/html-css.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- file: .github/instructions/html-css.instructions.md -->
22
<!-- version: 1.0.0 -->
3-
<!-- guid: 2d1e0f9a-8b7c-6d5e-4f3a-2b1c0d9e8f7a -->
4-
---
5-
applyTo: "**/*.{html,css}"
3+
4+
## <!-- guid: 2d1e0f9a-8b7c-6d5e-4f3a-2b1c0d9e8f7a -->
5+
6+
applyTo: "\*_/_.{html,css}"
67
description: |
7-
Coding, documentation, and workflow rules for HTML and CSS files, following Google HTML/CSS style guide and general project rules. Reference this for all HTML and CSS code, documentation, and formatting in this repository. All unique content from the Google HTML/CSS Style Guide is merged here.
8+
Coding, documentation, and workflow rules for HTML and CSS files, following Google HTML/CSS style guide and general project rules. Reference this for all HTML and CSS code, documentation, and formatting in this repository. All unique content from the Google HTML/CSS Style Guide is merged here.
9+
810
---
911

1012
# HTML/CSS Coding Instructions

‎.github/instructions/javascript.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- file: .github/instructions/javascript.instructions.md -->
22
<!-- version: 1.0.0 -->
3-
<!-- guid: 8e7d6c5b-4a3c-2d1e-0f9a-8b7c6d5e4f3a -->
4-
---
5-
applyTo: "**/*.js"
3+
4+
## <!-- guid: 8e7d6c5b-4a3c-2d1e-0f9a-8b7c6d5e4f3a -->
5+
6+
applyTo: "\*_/_.js"
67
description: |
7-
JavaScript language-specific coding, documentation, and testing rules for Copilot/AI agents and VS Code Copilot customization. These rules extend the general instructions in `general-coding.instructions.md` and merge all unique content from the Google JavaScript Style Guide.
8+
JavaScript language-specific coding, documentation, and testing rules for Copilot/AI agents and VS Code Copilot customization. These rules extend the general instructions in `general-coding.instructions.md` and merge all unique content from the Google JavaScript Style Guide.
9+
810
---
911

1012
# JavaScript Coding Instructions

‎.github/instructions/json.instructions.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- file: .github/instructions/json.instructions.md -->
22
<!-- version: 1.0.0 -->
3-
<!-- guid: 3c2d1e0f-9a8b-7c6d-5e4f-3a2b1c0d9e8f -->
4-
---
5-
applyTo: "**/*.json"
3+
4+
## <!-- guid: 3c2d1e0f-9a8b-7c6d-5e4f-3a2b1c0d9e8f -->
5+
6+
applyTo: "\*_/_.json"
67
description: |
7-
Coding, documentation, and workflow rules for JSON files, following Google JSON style guide and general project rules. Reference this for all JSON code, documentation, and formatting in this repository. All unique content from the Google JSON Style Guide is merged here.
8+
Coding, documentation, and workflow rules for JSON files, following Google JSON style guide and general project rules. Reference this for all JSON code, documentation, and formatting in this repository. All unique content from the Google JSON Style Guide is merged here.
9+
810
---
911

1012
# JSON Coding Instructions
@@ -36,6 +38,7 @@ description: |
3638
## Required File Header
3739

3840
All JSONC files must begin with a standard header as described in the [general coding instructions](general-coding.instructions.md). The **only exception** is files with the `.json` extension (JSON without comments), which are exempt from this requirement and do not require a file header. For standard `.jsonc` files, include the following header:
41+
3942
```jsonc
4043
// file: path/to/file.jsonc
4144
// version: 1.0.0

0 commit comments

Comments
 (0)