Skip to content

Add project infrastructure: issue templates, quality checks, and documentation#7

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

Add project infrastructure: issue templates, quality checks, and documentation#7
Malcolmnixon merged 3 commits intomainfrom
copilot/add-project-improvements

Conversation

Copy link
Contributor

Copilot AI commented Dec 26, 2025

Establishes project standards for contributions, automated quality enforcement, and dependency management.

GitHub Configuration

  • Issue templates: Bug report (🐛) and feature request (✨) forms with structured fields
  • Issue config: Disables blank issues, adds contact links to docs and discussions
  • Dependabot: Weekly grouped updates for GitHub Actions and NuGet packages

Quality Enforcement

  • Spelling: .cspell.json with project dictionary (weasyprint, dotnet, etc.)
  • Markdown linting: .markdownlint.json with relaxed line length rules
  • CI job: Quality Checks runs before build, validates all markdown files using npx
quality-checks:
  runs-on: ubuntu-24.04
  permissions:
    contents: read
  steps:
    - name: Check Spelling
      run: npx cspell "**/*.md"
    - name: Lint Markdown
      run: npx markdownlint-cli "**/*.md"

Documentation

  • CODE_OF_CONDUCT.md: Contributor Covenant v2.0
  • SECURITY.md: Vulnerability reporting via GitHub Security Advisories
  • CONTRIBUTING.md: Guidelines for contributions, emphasizes quality checks before PR
  • AGENTS.md: AI agent instructions for maintaining project standards

README Updates

  • Added NuGet package badge
  • Converted inline links to reference format for maintainability
  • Critical: All links use absolute URLs (README is distributed in NuGet package)
  • Added Contributing, Security, and Code of Conduct sections
[![NuGet][nuget-badge]][nuget-url]

[nuget-badge]: https://img.shields.io/nuget/v/DEMAConsulting.WeasyprintTool
[nuget-url]: https://www.nuget.org/packages/DEMAConsulting.WeasyprintTool/

Requirements Documentation

Both AGENTS.md and CONTRIBUTING.md explicitly document:

  • README.md must use absolute URLs (NuGet distribution constraint)
  • All markdown must pass cspell and markdownlint before commit
  • All markdown files use reference-style links
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)


💡 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.

…, and documentation

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review December 26, 2025 16:52
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add project improvements including templates and linting checks Add project infrastructure: issue templates, quality checks, and documentation Dec 26, 2025
Copilot AI requested a review from Malcolmnixon December 26, 2025 16:54
@Malcolmnixon Malcolmnixon merged commit 8ccff66 into main Dec 26, 2025
2 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-project-improvements branch December 26, 2025 16:54
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