Skip to content

Add project quality infrastructure and documentation#9

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/add-project-improvements
Dec 26, 2025
Merged

Add project quality infrastructure and documentation#9
Malcolmnixon merged 4 commits intomainfrom
copilot/add-project-improvements

Conversation

Copy link
Contributor

Copilot AI commented Dec 26, 2025

Adds standardized project infrastructure for issue management, automated dependency updates, quality enforcement, and contributor documentation.

GitHub Issue Management

  • Templates: Bug report and feature request forms with structured fields
  • Configuration: Disabled blank issues, added discussion and documentation contact links
  • Dependabot: Grouped weekly updates for GitHub Actions and NuGet dependencies

Quality Enforcement

  • Spelling: .cspell.json with project-specific dictionary
  • Markdown linting: .markdownlint.json with formatting rules
  • CI integration: Quality Checks job runs before build using npx cspell and npx markdownlint-cli

Documentation

  • CODE_OF_CONDUCT.md: Contributor Covenant 2.0
  • CONTRIBUTING.md: Development workflow, coding standards, and quality check requirements
  • SECURITY.md: Vulnerability reporting process and supported versions
  • AGENTS.md: AI agent instructions emphasizing absolute URLs in README (required for NuGet package distribution)

README Enhancements

  • Added NuGet version badge linking to package
  • Converted to markdown reference link format with absolute URLs only
  • Added sections linking to contributing guidelines, code of conduct, security policy

All documentation files pass spelling and linting checks. The Quality Checks workflow enforces these standards on future changes.

Original prompt

This section details on the original issue you should resolve

<issue_title>Project Improvements</issue_title>
<issue_description>The following project improvements are needed:

GitHub issue templates for bug reporting and feature requests with appropriate icons.
GitHub issue template configuration to disable blank issues and add contact links
GitHub dependabot configuration file to keep dependencies updated (grouping dependencies for fewer pull requests)
A .cspell.json file for spelling enforcement
A .markdownlint.json file for enforcing markdown file formatting.
A new "Quality Checks" job added to the build_on_push.yaml file to check spelling and markdown linting
The "Quality Checks" job should use npx to install and run cspell and markdownlint-cli
A standard CODE_OF_CONDUCT.md file should be added
A CONTRIBUTING.md file should be added
A SECURITY.md file should be added
An AGENTS.md file should be added
The README.md file should be improved, and include a badge for NuGet which links to the latest Nuget.org package
All Markdown links should use the Markdown link reference format
The README.md file should only contain absolute URL links as it will be distributed in the NuGet package - this should be documented in the AGENTS.md file and the CONTRIBUTING.md file
The AGENTS.md file should contain instructions that the spelling and markdown linting rules should be followed when performing updates and checked as part of testing the changes.</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.

Copilot AI and others added 3 commits December 26, 2025 15:46
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 project improvements including templates and configuration files Add project quality infrastructure and documentation Dec 26, 2025
Copilot AI requested a review from Malcolmnixon December 26, 2025 15:51
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.

Project Improvements

2 participants