Add AGENTS.md file and apply appropriate modifications.#33
Merged
Malcolmnixon merged 1 commit intomainfrom Dec 11, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces an AGENTS.md file to provide AI coding agents with context and instructions for working with the VHDLTest project, and updates the codebase to align with the guidelines specified in that document. The changes improve code organization and enforce stricter build requirements.
- Adds comprehensive AGENTS.md documentation for AI coding agents
- Renames test classes to follow the
[Component]Testsnaming convention - Enables
TreatWarningsAsErrorsin both main and test project files
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New documentation file providing project structure, development commands, testing guidelines, and code conventions for AI agents |
| src/DEMAConsulting.VHDLTest/DEMAConsulting.VHDLTest.csproj | Enables treating warnings as errors in the main project |
| test/DEMAConsulting.VHDLTest.Tests/DEMAConsulting.VHDLTest.Tests.csproj | Enables treating warnings as errors in the test project |
| test/DEMAConsulting.VHDLTest.Tests/ActiveHdlSimulatorTests.cs | Renames class from TestActiveHdlSimulator to ActiveHdlSimulatorTests and updates comment for consistency |
| test/DEMAConsulting.VHDLTest.Tests/ConfigDocumentTests.cs | Renames class from TestConfigDocument to ConfigDocumentTests |
| test/DEMAConsulting.VHDLTest.Tests/ContextTests.cs | Renames class from TestContext to ContextTests |
| test/DEMAConsulting.VHDLTest.Tests/ExitCodeTests.cs | Renames class from TestExitCode to ExitCodeTests |
| test/DEMAConsulting.VHDLTest.Tests/GhdlSimulatorTests.cs | Renames class from TestGhdlSimulator to GhdlSimulatorTests |
| test/DEMAConsulting.VHDLTest.Tests/ModelSimSimulatorTests.cs | Renames class from TestModelSimSimulator to ModelSimSimulatorTests |
| test/DEMAConsulting.VHDLTest.Tests/NvcSimulatorTests.cs | Renames class from TestNvcSimulator to NvcSimulatorTests |
| test/DEMAConsulting.VHDLTest.Tests/OptionsTests.cs | Renames class from TestOptions to OptionsTests |
| test/DEMAConsulting.VHDLTest.Tests/RunProcessorTests.cs | Renames class from TestRunProcessor to RunProcessorTests |
| test/DEMAConsulting.VHDLTest.Tests/SimulatorFactoryTests.cs | Renames class from TestSimulatorFactory to SimulatorFactoryTests |
| test/DEMAConsulting.VHDLTest.Tests/TestResultTests.cs | Renames class from TestTestResult to TestResultTests |
| test/DEMAConsulting.VHDLTest.Tests/TestResultsTests.cs | Renames class from TestTestResults to TestResultsTests |
| test/DEMAConsulting.VHDLTest.Tests/UsageTests.cs | Renames class from TestUsage to UsageTests |
| test/DEMAConsulting.VHDLTest.Tests/ValidationTests.cs | Renames class from TestValidation to ValidationTests |
| test/DEMAConsulting.VHDLTest.Tests/VersionTests.cs | Renames class from TestVersion to VersionTests |
| test/DEMAConsulting.VHDLTest.Tests/VivadoSimulatorTests.cs | Renames class from TestVivadoSimulator to VivadoSimulatorTests |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Malcolmnixon
force-pushed
the
add-agents-md
branch
from
a8df23a to
e9987af
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 19 out of 19 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds an AGENTS.md file and updates the code to be compliant with the AGENTS.md contents.