Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
8 changes: 4 additions & 4 deletions .github/agents/documentation-writer.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,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 +107,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
11 changes: 1 addition & 10 deletions .github/agents/project-maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,16 +199,7 @@

### 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.

Check failure on line 202 in .github/agents/project-maintainer.md

View workflow job for this annotation

GitHub Actions / Build / Quality Checks

Line length

.github/agents/project-maintainer.md:202:121 MD013/line-length Line length [Expected: 120; Actual: 171] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md013.md

## Integration with Development

Expand Down
19 changes: 5 additions & 14 deletions .github/agents/software-quality-enforcer.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,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 +240,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
10 changes: 5 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ ReqStream/
- **Linting**:
- **Markdown**: Must pass markdownlint (max line length: 120 chars)
- Lists must be surrounded by blank lines (MD032)
- Run locally: Check CI workflow for markdownlint-cli2-action usage
- Check CI workflow files in `.github/workflows/` for linting tool configurations
- **Spell Check**: Must pass cspell (custom dictionary in `.cspell.json`)
- Add project-specific terms to the custom dictionary if needed
- **YAML**: Must pass yamllint (2-space indentation, max line length: 120 chars)
Expand Down Expand Up @@ -162,10 +162,10 @@ 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:
- **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
4. **Linting**: **MANDATORY** - All linting checks must pass before pushing changes:
- **Markdown**: Must pass markdownlint checks - must pass with zero errors
- **Spell Check**: Must pass cspell checks - must pass with zero errors
- **YAML**: Must pass yamllint checks - 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

Expand Down
13 changes: 1 addition & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,18 +140,7 @@ The CI pipeline runs the following checks:
- **Spell checking**: Validates spelling in markdown and C# files
- **YAML linting**: Validates YAML file structure

You can run these locally if you have the tools installed:

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

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

# YAML linting
yamllint .
```
Refer to the CI/CD workflow files in `.github/workflows/` for specific linting tool configurations and versions.

## Pull Request Process

Expand Down
Loading