Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions .github/agents/documentation-writer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
name: Documentation Writer
description: Expert agent for creating, updating, and maintaining project documentation including README, guides, and API documentation
description: >-
Expert agent for creating, updating, and maintaining project documentation including README, guides, and API
documentation
---

# Documentation Writer Agent
Expand Down Expand Up @@ -66,8 +68,8 @@ update, and maintain high-quality documentation that is clear, accurate, and hel

Before finalizing documentation changes:

1. **Markdown Linting**: Run `markdownlint-cli2 "**/*.md"` if available
2. **Spell Checking**: Run `cspell "**/*.md"` if available
1. **Markdown Linting**: Ensure markdown files follow project conventions
2. **Spell Checking**: Verify spelling is correct
3. **Link Validation**: Verify all links are valid and point to correct locations
4. **Example Testing**: Test all code examples and CLI commands
5. **Consistency Review**: Ensure consistent terminology and formatting
Expand Down Expand Up @@ -107,7 +109,7 @@ Before finalizing documentation changes:

## Tools and Resources

- **Markdown Linting**: `.markdownlint.json` configuration
- **Spell Checking**: `.cspell.json` dictionary
- **Markdown Style**: Follow `.markdownlint.json` configuration
- **Spell Checking**: Follow `.cspell.json` dictionary
- **Style Guide**: Follow project conventions in AGENTS.md
- **Code of Conduct**: Reference CODE_OF_CONDUCT.md for community guidelines
15 changes: 4 additions & 11 deletions .github/agents/project-maintainer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
name: Project Maintainer
description: Expert agent for overall project management, dependency updates, CI/CD maintenance, and release coordination
description: >-
Expert agent for overall project management, dependency updates, CI/CD maintenance, and release coordination
---

# Project Maintainer Agent
Expand Down Expand Up @@ -199,16 +200,8 @@ dotnet pack --no-build --configuration Release

### Linting Commands

```bash
# Markdown linting
markdownlint-cli2 "**/*.md"

# Spell checking
cspell "**/*.md" "**/*.cs"

# YAML linting
yamllint .
```
Use the project's CI pipeline configuration as the source of truth for linting commands. Linting tools and their
specific versions are managed through the CI/CD workflows.

## Integration with Development

Expand Down
23 changes: 8 additions & 15 deletions .github/agents/software-quality-enforcer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
name: Software Quality Enforcer
description: Expert agent for code quality, testing standards, code reviews, security analysis, and ensuring adherence to coding conventions
description: >-
Expert agent for code quality, testing standards, code reviews, security analysis, and ensuring adherence to coding
conventions
---

# Software Quality Enforcer Agent
Expand Down Expand Up @@ -134,16 +136,7 @@ Based on `.editorconfig` and project preferences:

4. **Linting and Format Checks**

```bash
# Markdown linting
markdownlint-cli2 "**/*.md"

# Spell checking
cspell "**/*.md" "**/*.cs"

# YAML linting
yamllint .
```
Follow the project's CI/CD pipeline for linting configurations.

5. **Final Verification**
- Review all changed files
Expand Down Expand Up @@ -249,10 +242,10 @@ Based on `.editorconfig` and project preferences:

### Code Style

- `.editorconfig` for style rules
- `.markdownlint.json` for markdown
- `.yamllint.yaml` for YAML
- `.cspell.json` for spell checking
- Follow `.editorconfig` for style rules
- Follow `.markdownlint.json` for markdown
- Follow `.yamllint.yaml` for YAML
- Follow `.cspell.json` for spell checking

## Integration with Development

Expand Down
16 changes: 1 addition & 15 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,11 @@ Before completing any task, you **MUST** perform these checks in order and ensur
must pass with zero warnings
2. **Code Review**: Use `code_review` tool and address all valid concerns
3. **Security Scanning**: Use `codeql_checker` tool after code review - must report zero vulnerabilities
4. **Linting**: **MANDATORY** - Run all linters locally and fix any issues before pushing changes:
4. **Linting**: Run all linters locally and fix any issues before pushing changes:
- **Markdown**: Run markdownlint on all changed `.md` files - must pass with zero errors
- **Spell Check**: Run cspell on all changed files - must pass with zero errors
- **YAML**: Run yamllint on all changed `.yaml` or `.yml` files - must pass with zero errors
- These linters run in CI and will fail the build if not passing
- **DO NOT** rely solely on CI to catch linting issues - catch them locally first

## Project-Specific Guidelines

Expand Down Expand Up @@ -203,17 +202,4 @@ responsibilities, and project-specific conventions.
- **Software Quality Enforcer** (`.github/agents/software-quality-enforcer.md`) - Expert agent for code quality,
testing standards, code reviews, and security analysis

## Future Agents

As the project grows, we may add additional custom agents for:

- Test generation
- Requirements validation
- YAML file parsing and validation

## Contributing

If you have suggestions for custom agents that would benefit this project, please open an issue or submit a pull
request.

[architecture]: ARCHITECTURE.md
Loading