diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aba3a19..8983373 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,20 @@ -The content of this repository includes sample code for integrating Dragon Medical Speechkit Browser SDK into your web applications. These samples are intended to help developers learn and use the SDK. The code is public for anyone to view but is not meant to be modified and no pull requests will be accepted. +# Contributing to DMSK-dotnet -Interested third party developers should visit https://learn.microsoft.com/en-us/industry/healthcare/speechkit/ for further information about working with Dragon Medical SpeechKit. \ No newline at end of file +## Pull Request Policy + +**⚠️ No Pull Requests Accepted** + +The content of this repository includes sample code for integrating Dragon Medical SpeechKit .NET SDK into your applications. These samples are intended to help developers learn and use the SDK. The code is public for anyone to view but is not meant to be modified and **no pull requests will be accepted**. + +## Getting Help + +Interested third party developers should visit https://learn.microsoft.com/en-us/industry/healthcare/speechkit/ for further information about working with Dragon Medical SpeechKit. + +For questions about pull request approval processes, please see [PR_APPROVAL_POLICY.md](PR_APPROVAL_POLICY.md). + +## Reporting Issues + +If you encounter issues with the Dragon Medical SpeechKit: +- Visit the official documentation: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/ +- Use official Microsoft support channels +- Do not create GitHub issues in this repository as they will not be addressed \ No newline at end of file diff --git a/PR_APPROVAL_POLICY.md b/PR_APPROVAL_POLICY.md new file mode 100644 index 0000000..950028c --- /dev/null +++ b/PR_APPROVAL_POLICY.md @@ -0,0 +1,63 @@ +# Pull Request Approval Policy for DMSK-dotnet + +## Overview + +This document clarifies the pull request approval process for the Dragon Medical SpeechKit .NET SDK repository. + +## Repository Pull Request Policy + +**⚠️ Important Notice: This repository does not accept pull requests.** + +As stated in our [CONTRIBUTING.md](CONTRIBUTING.md): +> The code is public for anyone to view but is not meant to be modified and no pull requests will be accepted. + +### Why No Pull Requests? + +This repository contains sample code and SDK components for Dragon Medical SpeechKit. The code is: +- Provided as reference material and samples +- Maintained directly by Microsoft/Nuance +- Not intended for community contributions + +## Getting Support + +If you have questions, issues, or need assistance with Dragon Medical SpeechKit: + +1. **Documentation**: Visit the official documentation at https://learn.microsoft.com/en-us/industry/healthcare/speechkit/ +2. **Support**: Contact official support channels through the Microsoft Healthcare documentation +3. **SDK Updates**: Official updates are published through proper release channels + +## Application Document Approval Workflow + +If you're looking for information about document approval within the SpeechKit applications themselves, the codebase includes examples of document workflow management: + +### Document States + +The application uses several document states for workflow management: +- `DocumentStates.Undefined` - Default state +- `DocumentStates.Corrected` - Document has been reviewed and corrected +- `DocumentStates.Uncorrected` - Document needs correction + +### Example: Signing and Approving Documents + +```csharp +private void SignAndCloseButton_Click(object sender, RoutedEventArgs e) +{ + // Sign report -> set document state to Corrected + _documentState = DocumentStates.Corrected; + Close(); +} +``` + +### Closing Documents with State + +```csharp +// Close with document ID and state +_vuiController.Close(_documentId.Text, _documentState); +``` + +## Summary + +- **GitHub PRs**: Not accepted for this repository +- **Support**: Use official Microsoft Healthcare documentation and support channels +- **Document Approval**: Implemented within the application using DocumentStates enum +- **Code Reference**: Available for learning and integration guidance only \ No newline at end of file diff --git a/README.md b/README.md index 7a87875..bf96880 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Dragon Medical SpeechKit .NET SDK Temporary location for .NET SpeechKit package and samples. + +## Important Notice + +**This repository does not accept pull requests.** For information about pull request policies and document approval workflows, see [PR_APPROVAL_POLICY.md](PR_APPROVAL_POLICY.md). + +## Documentation and Resources + See the following pages for more information: [Setting up Dragon Medical SpeechKit](https://learn.microsoft.com/en-us/industry/healthcare/speechkit/net-sdk/setup)