Skip to content

Add AGENTS.md documentation and automated quality checks for markdown#8

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/add-agents-file-and-quality-checks
Dec 24, 2025
Merged

Add AGENTS.md documentation and automated quality checks for markdown#8
Malcolmnixon merged 4 commits intomainfrom
copilot/add-agents-file-and-quality-checks

Conversation

Copy link
Contributor

Copilot AI commented Dec 24, 2025

Adds repository documentation for GitHub Copilot agents and enforces spelling/markdown standards via CI.

New Files

  • AGENTS.md - Repository structure, development guidelines, and agent instructions
  • .cspell.json - Spelling dictionary with project-specific terms (Dotnet, nuspec, SBOM, etc.)
  • .markdownlint.json - Markdown rules: 120 char line length, HTML allowed, code blocks exempt

Workflow Changes

Added quality-checks job to build_on_push.yaml that gates the build:

quality-checks:
  name: Quality Checks
  runs-on: ubuntu-latest
  permissions:
    contents: read
  steps:
    - name: Run Spelling Check
      run: npx cspell "**/*.md"
    - name: Run Markdown Linting
      run: npx markdownlint-cli "**/*.md"

build:
  needs: quality-checks
  # ... existing build steps

Fixes

  • Wrapped long lines in README.md to meet 120 char limit
  • Added language specifier to fenced code block
  • Added node_modules to .gitignore
Original prompt

I would like to add an AGENTS.md file to this repository based on its current contents, and also adding .cspell.json and .markdownlint.json files to enforce spelling and markdown formatting. The spelling and markdown formatting should be performed by adding a new "Quality Checks" job to the build_on_push.yaml workflow file that runs the node cspell and markdownlint-cli tools.


💡 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 December 24, 2025 22:29
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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 AGENTS.md and quality checks to workflow Add AGENTS.md documentation and automated quality checks for markdown Dec 24, 2025
Copilot AI requested a review from Malcolmnixon December 24, 2025 22:33
@Malcolmnixon Malcolmnixon marked this pull request as ready for review December 24, 2025 22:35
@Malcolmnixon Malcolmnixon merged commit f834bdc into main Dec 24, 2025
5 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-agents-file-and-quality-checks branch December 24, 2025 22:35
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.

2 participants