Skip to content

Add comprehensive documentation for PR approval policy and repository contribution guidelines#2

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-2c7fa92b-6b13-418d-b72a-ea9e4b867e54
Draft

Add comprehensive documentation for PR approval policy and repository contribution guidelines#2
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-2c7fa92b-6b13-418d-b72a-ea9e4b867e54

Conversation

Copy link
Copy Markdown

Copilot AI commented Aug 20, 2025

This PR addresses the question "what is the correct method to approve a PR?" by adding comprehensive documentation that clarifies the repository's pull request policy and provides guidance for contributors.

Changes Made

1. Created PR_APPROVAL_POLICY.md

Added a detailed policy document that explains:

  • Repository PR Policy: This repository does not accept pull requests as it contains read-only sample code for Dragon Medical SpeechKit .NET SDK
  • Support Channels: Clear guidance on where to get help with Dragon Medical SpeechKit
  • Application Document Approval: Documentation of the internal document approval workflow found in the codebase, including DocumentStates enum usage and examples from the existing code

2. Enhanced CONTRIBUTING.md

Restructured the contribution guidelines with:

  • Clear warning about no pull requests being accepted
  • Better organization with proper headings and sections
  • Reference to the new PR policy document
  • Guidance on reporting issues through proper channels

3. Updated README.md

Added prominent notice in the main README that:

  • Immediately informs users that PRs are not accepted
  • References the detailed PR policy documentation
  • Maintains all existing documentation links

Context

The repository contains sample code for Dragon Medical SpeechKit .NET SDK integration. The codebase includes document approval workflows (using DocumentStates.Corrected, DocumentStates.Uncorrected, etc.) which could be confused with GitHub PR approval processes. This documentation clearly separates the two concepts and provides appropriate guidance for each.

Impact

  • For Contributors: Clear understanding that this is a read-only repository with no PR acceptance
  • For Support: Proper channels are now clearly documented
  • For Integration: Document approval workflow examples are properly documented for developers integrating with the SDK

The changes maintain the repository's purpose as a reference while eliminating confusion about contribution processes.


✨ 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: johndes <3543300+johndes@users.noreply.github.com>
Copilot AI changed the title [WIP] what is the correct method to approve a PR? Add comprehensive documentation for PR approval policy and repository contribution guidelines Aug 20, 2025
Copilot AI requested a review from johndes August 20, 2025 14:18
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