Skip to content

Standardize issue templates to match Dema Consulting standards#67

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/standardize-issue-templates
Jan 27, 2026
Merged

Standardize issue templates to match Dema Consulting standards#67
Malcolmnixon merged 2 commits intomainfrom
copilot/standardize-issue-templates

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 27, 2026

Pull Request

Description

Aligns VHDLTest issue templates with Dema Consulting standards using SarifMark as the reference implementation.

Bug Report Template Changes:

  • Added structured fields: Code Sample (C# syntax), Tool Version (required), .NET Version dropdown (.NET 8/9/10), Operating System
  • Replaced single Code of Conduct checkbox with 3-point validation checklist
  • Removed inline YAML comments for cleaner formatting

Feature Request Template Changes:

  • Added Usage Examples field with C# syntax highlighting
  • Added required Benefits field to justify feature value
  • Added Willingness to Contribute dropdown (can submit PR / need guidance / can test / just suggesting)
  • Reorganized priority options (Low/Medium/High instead of Critical/High/Medium/Low)
  • Replaced Code of Conduct checkbox with 3-point validation checklist

Config Template Changes:

  • Simplified contact link labels: "Ask a Question" and "Security Issue"
  • Standardized descriptions to match SarifMark wording

Pull Request Template (New):

  • Created comprehensive template with structured sections
  • Pre-submission checklist covering build/test, code quality, quality checks (cspell/markdownlint/yamllint), testing, and documentation
  • Includes Type of Change checkboxes and Related Issues section

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Issue template standardization to align with organization standards.

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All tests pass: dotnet test --configuration Release
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Templates validated with yamllint, markdownlint-cli2, and cspell. All formatting passes quality gates. No code changes required.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Issue Template Standardization</issue_title>
<issue_description>### Problem Statement

The VHDLTest Issue Templates differ from Dema Consulting standards.

Proposed Solution

Review a compliant project such as https://github.com/demaconsulting/SarifMark and:

  • Update this projects bug and feature templates to match
  • Update the issue config.yml file
  • Update the pull_request_template.md file (another file needing to conform to DemaConsulting standards).

Alternatives Considered

No response

Priority

Medium - Would be nice to have

Additional Context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update issue templates to conform to Dema Consulting standards Standardize issue templates to match Dema Consulting standards Jan 27, 2026
Copilot AI requested a review from Malcolmnixon January 27, 2026 03:18
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 27, 2026 03:22
@Malcolmnixon Malcolmnixon merged commit 1cbba06 into main Jan 27, 2026
21 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/standardize-issue-templates branch January 27, 2026 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Issue Template Standardization

2 participants