commit 74aba204d8fa5a76648149a69bc23685a2d9b626
parent c136d55519087455ab810f5d907554e1aca2ed21
Author: SkandaBT <9980056379Skanda@gmail.com>
Date: Wed, 3 Jul 2024 03:30:23 +0530
Update README.md and Pull Request and Issue templates (#4599)
<!-- To check a checkbox place an "x" between the brackets. e.g: [x] -->
- [X] I have signed the [Contributor License
Agreement](https://cla.opensource.microsoft.com/microsoft/winget-pkgs).
- [ ] This pull request is related to an issue.
-----
###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/microsoft/winget-cli/pull/4599)
---------
Co-authored-by: Kaleb Luedtke <trenlymc@gmail.com>
Co-authored-by: snyk-bot <snyk-bot@snyk.io>
Diffstat:
5 files changed, 15 insertions(+), 16 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.yml b/.github/ISSUE_TEMPLATE/Bug_Report.yml
@@ -4,7 +4,7 @@ body:
- type: markdown
attributes:
value: |
- > This bug tracker is monitored by Windows Package Manager development team and other technical folks.
+ > This bug tracker is monitored by the Windows Package Manager development team and other technical folks.
>
> **Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to GitHub issues**.
> Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue.
diff --git a/.github/ISSUE_TEMPLATE/Documentation_Issue.yml b/.github/ISSUE_TEMPLATE/Documentation_Issue.yml
@@ -5,6 +5,6 @@ body:
- type: textarea
attributes:
label: Brief description of your issue
- placeholder: Briefly describe which document needs to be corrected and why
+ placeholder: Briefly describe which document needs to be corrected and why.
validations:
required: true
diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.yml b/.github/ISSUE_TEMPLATE/Feature_Request.yml
@@ -13,6 +13,6 @@ body:
- type: textarea
attributes:
label: Proposed technical implementation details
- placeholder: A clear and concise description of what you want to happen
+ placeholder: A clear and concise description of what you want to happen.
validations:
required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -8,4 +8,4 @@ contact_links:
about: Have a question on something? Start a new discussion thread.
- name: Review open issues
url: https://github.com/microsoft/winget-cli/issues
- about: Please check if your issue or a similar issue has already been submitted
+ about: Please check if your issue or a similar issue has already been submitted.
diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-
#  Windows Package Manager
## WinGet Client
@@ -13,7 +12,7 @@ If you are new to the Windows Package Manager, you might want to [Explore the Wi
## Installing The Client
> [!NOTE]
-> The client requires Windows 10 1809 (build 17763) or later at this time. Windows Server 2019 is not supported as the Microsoft Store is not available nor are updated dependencies. It may be possible to install on Windows Server 2022, this should be considered experimental (not supported), and requires dependencies to be manually installed as well.
+> The client requires Windows 10 1809 (build 17763) or later at this time. Windows Server 2019 is not supported as the Microsoft Store is not available nor are updated dependencies. It may be possible to install on Windows Server 2022, this should be considered experimental (not supported) and requires dependencies to be manually installed as well.
### Microsoft Store [Recommended]
@@ -61,7 +60,7 @@ You can also [build the client yourself](#building-the-client). While the client
## Windows Package Manager Release Roadmap
-The plan for delivering next Windows Package Manager releases is described included in our [discussions](https://github.com/microsoft/winget-cli/discussions/2063), and will be updated as the project proceeds.
+The plan for delivering the next Windows Package Manager release is described and included in our [discussions](https://github.com/microsoft/winget-cli/discussions/2063), and will be updated as the project proceeds.
## Overview of the Windows Package Manager
@@ -77,19 +76,19 @@ This winget-cli repository includes the source code designed to build the client
### Sources
-The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retrieve the metadata about the packages, so that the client can act on it.
+The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retrieve the metadata about the packages so that the client can act on it.
* The default "winget" source includes packages in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).
* The default "msstore" source includes packages in the Microsoft Store.
-* It is also possible to host your own private [REST based](https://github.com/microsoft/winget-cli-restsource) source.
+* It is also possible to host your own private [REST-based](https://github.com/microsoft/winget-cli-restsource) source.
## Building the client
1. Clone the repository
2. Configure your system, please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
* [Dev Home](https://github.com/microsoft/devhome)'s machine configuration tool
- * WinGet configuration. Run `winget configure .configurations/configuration.dsc.yaml` from the project root so relative paths resolve correctly
-3. Run `vcpkg integrate install` from Developer Command Prompt for VS 2022. This is one time setup step until configuration file in step 2 is updated to work with vcpkg setup.
+ * WinGet configuration. Run `winget configure .configurations/configuration.dsc.yaml` from the project root so relative paths resolve correctly.
+3. Run `vcpkg integrate install` from the Developer Command Prompt for VS 2022. This is a one time setup step until the configuration file in step 2 is updated to work with vcpkg setup.
### Prerequisites
@@ -110,11 +109,11 @@ The client is built around the concept of sources; a set of packages effectively
### Building
-Open `winget-cli\src\AppInstallerCLI.sln` in Visual Studio and build. We currently only build using the solution; command line methods of building a VS solution should work as well. After the build finishes, deploy the solution from Build > Deploy Solution. You can then run the client from the command line using `wingetdev`.
+Open `winget-cli\src\AppInstallerCLI.sln` in Visual Studio and build. We currently only build using the solution; command-line methods of building a VS solution should work as well. After the build finishes, deploy the solution from Build > Deploy Solution. You can then run the client from the command line using `wingetdev`.
## Credit
-We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for his work on AppGet which helped us on the initial project direction for Windows Package Manager.
+We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for his work on AppGet which helped us with the initial project direction for Windows Package Manager.
## Contributing
@@ -137,11 +136,11 @@ The winget.exe client is instrumented to collect usage and diagnostic (error) da
If you build the client yourself the instrumentation will not be enabled and no data will be sent to Microsoft.
-The winget.exe client respects machine wide privacy settings and users can opt-out on their device, as documented in the Microsoft Windows privacy statement [here](https://support.microsoft.com/help/4468236/diagnostics-feedback-and-privacy-in-windows-10-microsoft-privacy). In addition, you may also explicitly block telemetry using [settings](https://docs.microsoft.com/windows/package-manager/winget/settings)
+The winget.exe client respects machine-wide privacy settings and users can opt-out on their device, as documented in the Microsoft Windows privacy statement [here](https://support.microsoft.com/help/4468236/diagnostics-feedback-and-privacy-in-windows-10-microsoft-privacy). In addition, you may also explicitly block telemetry using [settings](https://docs.microsoft.com/windows/package-manager/winget/settings)
-In short to opt-out, do one of the following:
+In short, to opt-out, do one of the following:
-**Windows 11**: Go to `Start`, then select `Settings` > `Privacy & security` > `Diagnostics & feedback` > `Diagnostic data` and unselect `Send optional diagnostic data`.
+**Windows 11**: Go to `Start`, then select `Settings` > `Privacy & Security` > `Diagnostics & feedback` > `Diagnostic data` and unselect `Send optional diagnostic data`.
**Windows 10**: Go to `Start`, then select `Settings` > `Privacy` > `Diagnostics & feedback`, and select `Required diagnostic data`.
