Add comprehensive documentation for PR approval policy and repository contribution guidelines#2
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
DocumentStatesenum usage and examples from the existing code2. Enhanced CONTRIBUTING.md
Restructured the contribution guidelines with:
3. Updated README.md
Added prominent notice in the main README that:
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
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.