Skip to content
Draft
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
87 changes: 0 additions & 87 deletions .cspell.json

This file was deleted.

114 changes: 114 additions & 0 deletions .cspell.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
# Spell-Checking
#
# PURPOSE:
# - Maintain professional documentation and code quality
# - Catch spelling errors before publication
# - Support consistent technical terminology usage
# - Misspelled words should be fixed in the source
# - NEVER add a misspelled word to the 'words' list
# - PROPOSE only genuine technical terms/names as needed

version: "0.2"
language: en

# Project-specific technical terms and tool names
words:
- activehdl
- Aldec
- alib
- acom
- Anson
- ASIC
- asim
- buildmark
- BuildMark
- build_notes
- camelcase
- code_quality
- code_review_plan
- code_review_report
- CodeQL
- copilot
- coverlet
- cspell
- csproj
- dcterms
- Dema
- demaconsulting
- dotnet
- dorny
- endsim
- ghdl
- gitattributes
- ibiqlik
- lifecycles
- markdownlint
- mingw
- mcode
- modelsim
- mstest
- msys
- msystem
- netanalyzers
- nickg
- nlog
- nupkg
- opencover
- pandoc
- pandoctool
- PATHEXT
- Questa
- QuestaSim
- reqstream
- ReqStream
- requirements_doc
- requirements_report
- reviewmark
- ReviewMark
- runall
- Sarif
- SarifMark
- sarifmark
- sbom
- SBOM
- screencasts
- slnx
- snupkg
- sonarcloud
- sonarscanner
- spdx
- testbench
- testbenches
- trace_matrix
- tracematrix
- trx
- vcom
- VHDL
- vhdl
- vhdltest
- vlib
- vivado
- vsim
- vsimsa
- Weasyprint
- weasyprinttool
- worklib
- xelab
- Xilinx
- xvhdl
- yaml
- yamllint

# Exclude common build artifacts, dependencies, and vendored third-party code
ignorePaths:
- "**/.git/**"
- "**/node_modules/**"
- "**/.venv/**"
- "**/thirdparty/**"
- "**/third-party/**"
- "**/3rd-party/**"
- "**/AGENT_REPORT_*.md"
- "**/bin/**"
- "**/obj/**"
- package-lock.json
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Set default behavior: normalize line endings to LF on checkout for all text files.
# This ensures consistent SHA256 fingerprints for reviewmark across all platforms.
* text=auto eol=lf

# Windows batch files require CRLF line endings to function correctly.
*.bat text eol=crlf
*.cmd text eol=crlf
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
name: Code Quality Agent
description: Ensures code quality through linting and static analysis - responsible for security, maintainability, and correctness
name: code-quality
description: Ensures code quality through comprehensive linting and static analysis.
tools: [read, search, edit, execute, github, agent]
user-invocable: true
---

# Code Quality Agent - VHDLTest
Expand All @@ -9,7 +11,7 @@ Enforce quality standards through linting, static analysis, and security scannin

## When to Invoke This Agent

Invoke the code-quality-agent for:
Invoke the code-quality agent for:

- Running and fixing linting issues (markdown, YAML, spell check, code formatting)
- Ensuring static analysis passes with zero warnings
Expand All @@ -31,8 +33,8 @@ Ensure the project is:

1. **Build**: Zero warnings (TreatWarningsAsErrors=true)
2. **Linting**:
- markdownlint (`.markdownlint-cli2.jsonc`)
- cspell (`.cspell.json`)
- markdownlint (`.markdownlint-cli2.yaml`)
- cspell (`.cspell.yaml`)
- yamllint (`.yamllint.yaml`)
- dotnet format (`.editorconfig`)
3. **Static Analysis**:
Expand Down Expand Up @@ -76,7 +78,7 @@ lint.bat # Windows
- **Software Developer Agent**: For fixing production code issues
- **Test Developer Agent**: For fixing test code issues

## Don't
## Don't Do These Things

- Disable quality checks to make builds pass
- Ignore security warnings
Expand Down
46 changes: 46 additions & 0 deletions .github/agents/code-review.agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: code-review
description: Assists in performing formal file reviews.
tools: [read, search, edit, execute, github, web, agent]
user-invocable: true
---

# Code Review Agent

Execute comprehensive code reviews with emphasis on structured compliance verification and file review status
requirements.

## Reporting

Create a report using the filename pattern `AGENT_REPORT_code_review_[review-set].md`
(e.g., `AGENT_REPORT_code_review_auth-module.md`) to document review criteria, identified issues, and recommendations
for the specific review-set.

## Review Steps

1. Download the
<https://github.com/demaconsulting/ContinuousCompliance/raw/refs/heads/main/docs/review-template/review-template.md>
to get the checklist to fill in
2. Use `dotnet reviewmark --elaborate [review-set]` to get the files to review
3. Review the files all together
4. Populate the checklist with the findings to make the report

## Hand-off to Other Agents

Only attempt to apply review fixes if requested.

- If code quality, logic, or structural issues need fixing, call the @software-developer agent
- If test coverage gaps or quality issues are identified, call the @test-developer agent
- If documentation accuracy or completeness issues are found, call the @technical-writer agent
- If quality gate verification is needed after fixes, call the @code-quality agent
- If requirements traceability issues are discovered, call the @requirements agent

## Don't Do These Things

- **Never modify code during review** (document findings only, delegate fixes)
- **Never skip applicable checklist items** (comprehensive review required)
- **Never approve reviews with unresolved critical findings**
- **Never bypass review status requirements** for compliance
- **Never conduct reviews without proper documentation**
- **Never ignore security or compliance findings**
- **Never approve without verifying all quality gates**
Loading