Skip to content

Add pull request template with quality check reminders#75

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/add-pull-request-template
Jan 20, 2026
Merged

Add pull request template with quality check reminders#75
Malcolmnixon merged 3 commits intomainfrom
copilot/add-pull-request-template

Conversation

Copy link
Contributor

Copilot AI commented Jan 20, 2026

Pull Request

Description

Adds PR template to surface quality checks (cspell, markdownlint, yamllint) in contributor workflow. Addresses recurring pattern of PRs failing CI due to missed linting steps.

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

Addresses quality check failures in contributor PRs

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

Changes:

  • Created .github/pull_request_template.md with structured pre-submission checklist
  • Updated CONTRIBUTING.md to include yamllint in quality checks section

Template includes:

  • Explicit commands for cspell, markdownlint, yamllint with glob patterns
  • Build/test requirements, code quality checks, documentation reminders
  • Consistent command syntax across all linters

Template auto-displays on PR creation, surfacing checks before CI runs.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • googlechromelabs.github.io
    • Triggering command: /usr/local/bin/node node install.mjs (dns block)
  • https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/linux64/chrome-headless-shell-linux64.zip
    • Triggering command: /usr/local/bin/node node install.mjs (http block)
  • https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/linux64/chrome-linux64.zip
    • Triggering command: /usr/local/bin/node node install.mjs (http block)
  • https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
    • Triggering command: /usr/local/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Pull Request Template</issue_title>
<issue_description>### Problem Statement

Most of the time AI agents submit pull requests with simple code-quality (cspell, markdownlint, yamllint) issues.

Proposed Solution

Add a Pull Request template that specifically lists the checks that must be done before creating the pull request - including specific checks for running cspell, markdownlint, and yamllint.

Alternatives Considered

No response

Usage Examples

Benefits

Hopefully making sure the agents don't forget to run the checks.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

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


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 20, 2026 20:17
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add pull request template for code quality checks Add pull request template with quality check reminders Jan 20, 2026
Copilot AI requested a review from Malcolmnixon January 20, 2026 20:20
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 20, 2026 21:56
@Malcolmnixon Malcolmnixon merged commit 25087cc into main Jan 20, 2026
9 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-pull-request-template branch January 20, 2026 21:56
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]: Pull Request Template

2 participants