Skip to content

Commit

Permalink
Added Guidelines for GitHub issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Xelu86 committed Oct 4, 2023
1 parent 564a5e1 commit 13a34af
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Windows Server Documentation

Welcome to the open source documentation of Microsoft Windows Server. Contributing to open source is more than just providing updates, it's also letting us know when there is an issue.
Welcome to the open source documentation of Microsoft Windows Server. Contributing to open source is more than just providing updates, it's also letting us know when there's an issue.

## Public vs. private repo contributions

Expand All @@ -23,14 +23,42 @@ These repos are actively managed and contain the source for Windows Server techn
- [Windows Server home page](https://learn.microsoft.com/windows-server/)
- [Windows Server Essentials](https://learn.microsoft.com/windows-server-essentials)

## GitHub content feedback guidelines

As the Windows Server repo in GitHub is only monitored for content issues, users can help in contributing by reporting documentation issues. Select the "**This page**" button under the **Feedback** section of the page to generate a GitHub issue where feedback can be provided concerning a documentation issue. Suggestions for improvement are welcomed and specific updates to our content are under consideration.

A best practice in providing valuable feedback is to capture the issue directly by quoting where the issue is found within the document. The following list provides insight to issues that are addressable:

- Incorrect spelling, typos or duplicate text in the documentation.
- Broken, outdated or incorrectly referenced hyperlinks to our content.
- The step-by-step directions provided don't match the product, steps are missing or are outdated.
- Incorrect code, missing parameters, or improper examples of command line usage or PowerShell cmdlets.

There are cases where the given feedback is outside the scope of what can be addressed as the issue pertains to the product or service rather than the documentation itself. For reference:

- Technical support for specific or case-based scenarios where troubleshooting is involved.
- Fixing a software bug, application feature requests, or experiencing product performance issues.
- Dislike of a product GUI change or removal of a product feature.
- Other issues that don't relate to the actual content.

We offer other channels for engaging with us whether you have a support question, want to provide product feedback, or other suggestions. Use one or more of these channels:

- Open a ticket with [Microsoft Support](https://support.microsoft.com/ContactUs).
- You can submit feedback by visiting our [Feedback portal](https://learn.microsoft.com/microsoft-365/admin/misc/feedback-provide-microsoft?view=o365-worldwide).
- To submit a bug or a feature request, use our [Windows Feedback Hub](https://aka.ms/WIPFeedbackHub) or press <kbd>**Windows key + F**</kbd>.
- You can also search and engage within our community forums:
- [Microsoft TechNet](https://social.technet.microsoft.com/Forums/home).
- [Microsoft Developer Network](https://social.msdn.microsoft.com/Forums/home).
- [Microsoft Support Community](https://answers.microsoft.com/).

## Markdown info

For information on using Markdown in Microsoft technical articles, see the [Docs Markdown reference](https://learn.microsoft.com/contribute/markdown-reference).

## License

Please refer to [LICENSE](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/LICENSE), [LICENSE-CODE](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/LICENSE-CODE) and [ThirdPartyNotices](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/ThirdPartyNotices) for all Licensing information.
Refer to [LICENSE](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/LICENSE), [LICENSE-CODE](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/LICENSE-CODE) and [ThirdPartyNotices](https://github.com/MicrosoftDocs/windowsserverdocs-pr/blob/master/ThirdPartyNotices) for all Licensing information.

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 comments on commit 13a34af

Please sign in to comment.