-
Notifications
You must be signed in to change notification settings - Fork 2
docs(audit): Phase 2 Extended README Audit - 13 nested directory files #698
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.
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
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3d8a243
fix(audit): Phase 2 - Fix nested directory README files accessibility…
claude 8f6fe8c
fix(audit): Correct Mermaid diagram syntax - accessibility attributes…
claude 7c1b28b
docs(audit): Phase 2 Extended README Audit Report - 13 nested directo…
claude f985845
Fix frontmatter validation for discussion template directory
claude 2ddb636
Fix review feedback: correct Mermaid syntax, links, and add frontmatter
claude 9a6a18d
Fix frontmatter validation for schemas directory
claude File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,106 @@ | ||
| -e # Folder Contents | ||
| --- | ||
| file_type: "documentation" | ||
| title: ".github Prompts Directory" | ||
| description: "AI prompt templates and guidelines for automation, code review, and documentation generation" | ||
| version: "v1.0" | ||
| last_updated: "2026-05-31" | ||
| maintainer: "LightSpeed Team" | ||
| tags: ["prompts", "ai", "automation", "templates"] | ||
| --- | ||
|
|
||
| This folder contains scripts and documentation for automation. | ||
| # .github Prompts Directory | ||
|
|
||
| --- | ||
| This directory contains reusable AI prompt templates designed for automation agents, code review, documentation generation, and AI-powered workflows across the LightSpeed organization. | ||
|
|
||
| ## Prompt Categories | ||
|
|
||
| ### Code Review & Quality | ||
|
|
||
| - **code-review.prompt.md** - Automated code quality assessment and feedback | ||
| - **accessibility-review.prompt.md** - WCAG 2.2 AA compliance validation | ||
| - **security-review.prompt.md** - Security vulnerability and OWASP analysis | ||
| - **performance-review.prompt.md** - Performance optimization recommendations | ||
|
|
||
| ### Documentation & Content | ||
|
|
||
| - **documentation.prompt.md** - Documentation generation and standardization | ||
| - **markdown-validation.prompt.md** - Markdown syntax and structure validation | ||
| - **frontmatter-guidance.prompt.md** - Frontmatter metadata generation | ||
|
|
||
| ### Automation & Workflows | ||
|
|
||
| - **labeling.prompt.md** - Issue and PR label suggestions | ||
| - **triage.prompt.md** - Issue categorization and routing | ||
| - **release-notes.prompt.md** - Release documentation generation | ||
|
|
||
| ### Pattern & Template Generation | ||
|
|
||
| - **pattern-generation.prompt.md** - Code pattern and template creation | ||
| - **architecture-review.prompt.md** - Architecture documentation and analysis | ||
| - **testing-guidance.prompt.md** - Test case and coverage recommendations | ||
|
Comment on lines
+17
to
+40
|
||
|
|
||
| ## Usage | ||
|
|
||
| ### With Copilot / Claude | ||
|
|
||
| Auto-generated documentation stub by folder-and-file-readmes.sh on Thu Nov 27 15:15:12 SAST 2025 | ||
| 1. Copy the relevant prompt template | ||
| 2. Paste into your AI assistant chat | ||
| 3. Provide repository context or specific code | ||
| 4. Follow the prompt structure for best results | ||
|
|
||
| *Docs signed by 🤖 Copilot for LightSpeedWP – always fresh!* | ||
| ### With Custom Agents | ||
|
|
||
| *Docs signed by 🤖 Copilot for LightSpeedWP – always fresh!* | ||
| 1. Load prompts from this directory in agent specifications | ||
| 2. Combine with runtime context (files, diffs, issues) | ||
| 3. Use responses for automated workflows | ||
| 4. Log results for quality metrics | ||
|
|
||
| *Docs signed by 🤖 Copilot for LightSpeedWP – always fresh!* | ||
| ### With Automation Workflows | ||
|
|
||
| 1. Reference prompts in workflow files (e.g., `.github/workflows/*.yml`) | ||
| 2. Pass relevant context via environment variables | ||
| 3. Parse responses and take action | ||
| 4. Track metrics and feedback | ||
|
|
||
| ## Prompt Structure | ||
|
|
||
| Each prompt includes: | ||
|
|
||
| - **Role & Context** - The AI's role and the problem domain | ||
| - **Objective** - Specific goals and success criteria | ||
| - **Input Specifications** - What information will be provided | ||
| - **Output Format** - Expected response structure and format | ||
| - **Quality Standards** - Accuracy, completeness, and style requirements | ||
| - **Examples** - Sample inputs and expected outputs | ||
| - **Edge Cases** - Known limitations and special handling | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - **Versioning**: Update version field when prompt logic changes significantly | ||
| - **Context**: Provide sufficient context for accurate responses | ||
| - **Iteration**: Refine prompts based on feedback and results | ||
| - **Documentation**: Keep prompt purpose and limitations documented | ||
| - **Testing**: Validate prompt outputs before relying on them in automation | ||
| - **Accessibility**: Ensure prompts produce accessible, standards-compliant content | ||
|
|
||
| ## Related Resources | ||
|
|
||
| - [Automation Governance](../../docs/AUTOMATION_GOVERNANCE.md) - Prompt usage policies | ||
|
|
||
| - [Agents Directory](../agents/README.md) - Agent specifications using these prompts | ||
| - [Instructions](../instructions/README.md) - Development standards referenced by prompts | ||
| - [Custom Instructions](../custom-instructions.md) - Organization-wide Copilot settings | ||
|
|
||
| ## Contributing | ||
|
|
||
| To add or improve prompts: | ||
|
|
||
| 1. Follow the standardized prompt structure above | ||
| 2. Include clear examples and edge cases | ||
| 3. Document the prompt's purpose and limitations | ||
| 4. Test with multiple inputs before submitting | ||
| 5. Update this README with new prompt entries | ||
|
|
||
| --- | ||
|
|
||
| *Docs signed by 🤖 Copilot for LightSpeedWP – always fresh!* | ||
| *Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team* | ||
| [Org Profile](https://github.com/lightspeedwp/.github/tree/main/profile) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new prompt catalogue now advertises templates such as
accessibility-review.prompt.md,security-review.prompt.md, andperformance-review.prompt.md, but I checked.github/promptswithrg --files .github/promptsand those files are not present; only a few listed names such ascode-review.prompt.mdandlabeling.prompt.mdexist. Consumers using this README to pick an automation prompt will be sent to non-existent templates, so please either rename these entries to the actual files in this directory or add the missing prompt files.Useful? React with 👍 / 👎.