You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ Below is our guidance for how to report issues, propose new features, and submit
6
6
7
7
The Windows Package Manager team is VERY active in this GitHub Repository. In fact, we live in it all day long and carry out all our development in the open!
8
8
9
-
When the team finds issues we file them in the repository. When we propose new ideas or think-up new features, we file new feature requests. When we work on fixes or features, we create branches and work on those improvements. And when PRs are reviewed, we review in public - including all the good, the bad, and the ugly parts.
9
+
When the team finds issues we file them in the repository. When we propose new ideas or thinkup new features, we file new feature requests. When we work on fixes or features, we create branches and work on those improvements. And when PRs are reviewed, we review them in public - including all the good, the bad, and the ugly parts.
10
10
11
-
The point of doing all this work in public is to ensure that we are holding ourselves to a high degree of transparency, and so that the community sees that we apply the same processes and hold ourselves to the same quality-bar as we do to community-submitted issues and PRs. We also want to make sure that we expose our team culture and "tribal knowledge" that is inherent in any closely-knit team, which often contains considerable value to those new to the project who are trying to figure out "why the heck does this thing look/work like this???"
11
+
The point of doing all this work in public is to ensure that we are holding ourselves to a high degree of transparency, and so that the community sees that we apply the same processes and hold ourselves to the same qualitybar as we do to community-submitted issues and PRs. We also want to make sure that we expose our team culture and "tribal knowledge" that is inherent in any closely-knit team, which often contains considerable value to those new to the project who are trying to figure out "why the heck does this thing look/work like this???"
12
12
13
13
### Repository Bot
14
14
@@ -79,27 +79,27 @@ For those able & willing to help fix issues and/or implement features ...
79
79
80
80
Some issues/features may be quick and simple to describe and understand. For such scenarios, once a team member has agreed with your approach, skip ahead to the section headed "Fork, Branch, and Create your PR", below.
81
81
82
-
Small issues that do not require a spec will be labelled Issue-Bug or Issue-Task.
82
+
Small issues that do not require a spec will be labeled Issue-Bug or Issue-Task.
83
83
84
84
However, some issues/features will require careful thought & formal design before implementation. For these scenarios, we'll request that a spec is written and the associated issue will be labeled Issue-Feature.
85
85
86
-
Specs help collaborators discuss different approaches to solve a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run.
86
+
Specs help collaborators discuss different approaches to solving a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run.
87
87
88
-
Specs will be managed in a very similar manner as code contributions so please follow the "Fork, Branch and Create your PR" below.
88
+
Specs will be managed in a very similar manner as code contributions so please follow the "Fork, Branch, and Create your PR" below.
89
89
90
90
### Writing / Contributing-to a Spec
91
91
92
-
To write/contribute to a spec: fork, branch and commit via PRs, as you would with any code changes.
92
+
To write/contribute to a spec: fork, branch, and commit via PRs, as you would with any code changes.
93
93
94
-
Specs are written in markdown, stored under the `/doc/specs` folder and named `[issue id] - [spec description].md`.
94
+
Specs are written in markdown, stored under the `/doc/specs` folder, and named `[issue id] - [spec description].md`.
95
95
96
96
👉 **It is important to follow the spec templates and complete the requested information**. The available spec templates will help ensure that specs contain the minimum information & decisions necessary to permit development to begin. In particular, specs require you to confirm that you've already discussed the issue/idea with the team in an issue and that you provide the issue ID for reference.
97
97
98
98
Team members will be happy to help review specs and guide them to completion.
99
99
100
100
### Help Wanted
101
101
102
-
Once the team have approved an issue/spec, development can proceed. If no developers are immediately available, the spec can be parked ready for a developer to get started. Parked specs' issues will be labeled "Help Wanted". To find a list of development opportunities waiting for developer involvement, visit the Issues and filter on [the Help-Wanted label](https://github.com/microsoft/winget-cli/labels/Help%20Wanted).
102
+
Once the team has approved an issue/spec, development can proceed. If no developers are immediately available, the spec can be parked ready for a developer to get started. Parked specs' issues will be labeled "Help Wanted". To find a list of development opportunities waiting for developer involvement, visit the Issues and filter on [the Help-Wanted label](https://github.com/microsoft/winget-cli/labels/Help%20Wanted).
103
103
104
104
---
105
105
@@ -122,9 +122,9 @@ Testing is a key component in the development workflow.
122
122
123
123
### Code Review
124
124
125
-
When you'd like the team to take a look, (even if the work is not yet fully-complete), mark the Draft PR as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. It may take several cycles, but the end result will be solid, testable, conformant code that is safe for us to merge.
125
+
When you'd like the team to take a look, (even if the work is not yet fully-complete), mark the Draft PR as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. It may take several cycles, but the result will be solid, testable, conformant code that is safe for us to merge.
126
126
127
-
> ⚠ Remember: **changes you make may affect both the Windows Package Manager and the schema support implemented in our validation pipelines!** Because of this, we will treat community PR's with the same level of scrutiny and rigor as commits submitted to the official Windows source by team members and partners.
127
+
> ⚠ Remember: **changes you make may affect both the Windows Package Manager and the schema support implemented in our validation pipelines!** Because of this, we will treat community PRs with the same level of scrutiny and rigor as commits submitted to the official Windows source by team members and partners.
Installer behavior can be different depending on whether you are running **winget** with administrator privileges.
48
48
49
-
* When running **winget** without administrator privileges, some applications may [require elevation](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works) to install. When the installer runs, Windows will prompt you to [elevate](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience). If you choose not to elevate, the application will fail to install.
49
+
* When running **WinGet** without administrator privileges, some applications may [require elevation](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works) to install. When the installer runs, Windows will prompt you to [elevate](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience). If you choose not to elevate, the application will fail to install.
50
50
51
-
* When running **winget** in an Administrator Command Prompt, you will not see [elevation prompts](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience) if the application requires it. Always use caution when running your command prompt as an administrator, and only install applications you trust.
51
+
* When running **WinGet** in an Administrator Command Prompt, you will not see [elevation prompts](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience) if the application requires it. Always use caution when running your command prompt as an administrator, and only install applications you trust.
52
52
53
53
### Build your own
54
54
@@ -88,14 +88,14 @@ The client is built around the concept of sources; a set of packages effectively
88
88
2. Configure your system, please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
* WinGet configuration. Run `winget configure .configurations/configuration.dsc.yaml` from the project root so relative paths resolve correctly.
91
-
3. Run `vcpkg integrate install` from the Developer Command Prompt for VS 2022. This is a onetime setup step until the configuration file in step 2 is updated to work with vcpkg setup.
91
+
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.
*[Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
98
-
* Or use winget to install it ;) (although you may need to adjust the workloads via Tools->Get Tools and Features...)
98
+
* Or use WinGet to install it ;) (although you may need to adjust the workloads via Tools->Get Tools and Features...)
99
99
* The following workloads:
100
100
* .NET Desktop Development
101
101
* Desktop Development with C++
@@ -118,8 +118,7 @@ We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for h
118
118
## Contributing
119
119
120
120
This project welcomes contributions and suggestions. Most contributions require you to agree to a
121
-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
122
-
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. More
121
+
Contributor License Agreement (CLA) declaring that you have the right to, and do, actually grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. More
123
122
information is available in our [CONTRIBUTING.md](/CONTRIBUTING.md) file.
124
123
125
124
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
Copy file name to clipboardExpand all lines: SECURITY.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
2
-
3
2
## Security
4
3
5
4
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
0 commit comments