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
{{ message }}
Repository navigation
Commit 9b0c1a9
Browse filesBrowse the repository at this point in the historyBrowse files
# Copyright (c) Microsoft Corporation. All rights reserved.
2
+
# Copyright (c) Microsoft Corporation.
3
3
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+22-20Lines changed: 22 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Please read the rest of this document to ensure a smooth contribution process.
19
19
20
20
## Quick Start Checklist
21
21
22
-
* Review the [Contribution License Agreement][CLA] requirement.
22
+
* Review the [Contributor License Agreement][CLA] requirement.
23
23
* Get familiar with the [PowerShell repository](../docs/git).
24
24
25
25
## Contributing to Issues
@@ -115,7 +115,7 @@ Please see [Building PowerShell](../README.md#building-the-repository).
115
115
116
116
#### Testing PowerShell
117
117
118
-
Please see PowerShell [Testing Guidelines - Running Tests Outside of CI][running-tests-outside-of-ci] on how to test you build locally.
118
+
Please see PowerShell [Testing Guidelines - Running Tests Outside of CI][running-tests-outside-of-ci] on how to test your build locally.
119
119
120
120
### Finding or creating an issue
121
121
@@ -167,11 +167,11 @@ Additional references:
167
167
An issue title is to briefly describe what is wrong, while a PR title is to briefly describe what is changed.
168
168
A better example is: "Add Ensure parameter to New-Item cmdlet", with "Fix #5" in the PR's body.
169
169
* When you create a pull request,
170
-
including a summary about your changes in the PR description.
170
+
include a summary about your changes in the PR description.
171
171
The description is used to create change logs,
172
172
so try to have the first sentence explain the benefit to end users.
173
173
If the changes are related to an existing GitHub issue,
174
-
please reference the issue in PR description (e.g. ```Fix #11```).
174
+
please reference the issue in the PR description (e.g. ```Fix #11```).
175
175
See [this][closing-via-message] for more details.
176
176
177
177
* Please use the present tense and imperative mood when describing your changes:
@@ -196,15 +196,15 @@ Additional references:
196
196
* For `.h`, `.cpp`, and `.cs` files use the copyright header with empty line after it:
197
197
198
198
```c#
199
-
// Copyright (c) Microsoft Corporation. All rights reserved.
199
+
// Copyright (c) Microsoft Corporation.
200
200
// Licensed under the MIT License.
201
201
<Addemptylinehere>
202
202
```
203
203
204
204
*For `.ps1` and `.psm1` filesusethecopyrightheaderwithemptylineafterit:
205
205
206
206
```powershell
207
-
# Copyright (c) Microsoft Corporation. All rights reserved.
207
+
# Copyright (c) Microsoft Corporation.
208
208
# Licensed under the MIT License.
209
209
<Addemptylinehere>
210
210
```
@@ -214,7 +214,7 @@ Additional references:
214
214
```powershell
215
215
Author="PowerShell"
216
216
Company="Microsoft Corporation"
217
-
Copyright="Copyright (c) Microsoft Corporation. All rights reserved."
217
+
Copyright="Copyright (c) Microsoft Corporation."
218
218
```
219
219
220
220
isatthetop.
@@ -277,10 +277,10 @@ Additional references:
277
277
-`Request changes` if you believe the PR merge should be blocked if your feedback is not addressed,
278
278
-`Approve` if you believe your feedback has been addressed or the code is fine as-is, it is customary (although not required) to leave a simple "Looks good to me" (or "LGTM") as the comment for approval.
279
279
-`Comment` if you are making suggestions that the *author* does not have to accept.
280
-
Early in the review, it is acceptable to provide feedback on coding formatting based on the published [Coding Guidelines](../docs/dev-process/coding-guidelines.md), however,
281
-
after the PR has been approved, it is generally _not_ recommended to focus on formatting issues unless they go against the [Coding Guidelines](../docs/dev-process/coding-guidelines.md).
280
+
Early in the review, it is acceptable to provide feedback on coding formatting based on the published [Coding Guidelines][coding-guidelines], however,
281
+
after the PR has been approved, it is generally _not_ recommended to focus on formatting issues unless they go against the [Coding Guidelines][coding-guidelines].
282
282
Non-critical late feedback (after PR has been approved) can be submitted as a new issue or new pull request from the *reviewer*.
283
-
1.*Assignee* who are always *Maintainers* ensure that proper review has occurred and if they believe one approval is not sufficient, the *maintainer* is responsible to add more reviewers.
283
+
1.*Assignees* who are always *Maintainers* ensure that proper review has occurred and if they believe one approval is not sufficient, the *maintainer* is responsible to add more reviewers.
284
284
An *assignee* may also be a reviewer, but the roles are distinct.
285
285
Once the PR has been approved and the CI system is passing, the *assignee* will merge the PR after giving one business day for any critical feedback.
286
286
For more information on the PowerShell Maintainers' process, see the [documentation](../docs/maintainers).
@@ -302,22 +302,22 @@ In these cases:
302
302
## Making Breaking Changes
303
303
304
304
When you make code changes,
305
-
please pay attention to these that can affect the [Public Contract](../docs/dev-process/breaking-change-contract.md).
305
+
please pay attention to these that can affect the [Public Contract][breaking-changes-contract].
306
306
For example, changing PowerShell parameters, APIs, or protocols break the public contract.
307
307
Before making changes to the code,
308
-
first review the [breaking changes contract](../docs/dev-process/breaking-change-contract.md)
308
+
first review the [breaking changes contract][breaking-changes-contract]
309
309
and follow the guidelines to keep PowerShell backward compatible.
310
310
311
311
## Making Design Changes
312
312
313
313
To add new features such as cmdlets or making design changes,
314
-
please follow the [PowerShell Request for Comments (RFC)](https://github.com/PowerShell/PowerShell-RFC) process.
314
+
please follow the [PowerShell Request for Comments (RFC)][rfc-process] process.
315
315
316
316
## Common Engineering Practices
317
317
318
-
Other than the guidelines for ([coding](../docs/dev-process/coding-guidelines.md),
319
-
the [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design,
320
-
[documentation](#contributing-to-documentation) and [testing](../docs/testing-guidelines/testing-guidelines.md)) discussed above,
318
+
Other than the guidelines for [coding][coding-guidelines],
319
+
the [RFC process][rfc-process] for design,
320
+
[documentation](#contributing-to-documentation) and [testing](../docs/testing-guidelines/testing-guidelines.md) discussed above,
321
321
we encourage contributors to follow these common engineering practices:
322
322
323
323
* Format commit messages following these guidelines:
@@ -359,7 +359,7 @@ is also appropriate, as is using Markdown syntax.
359
359
If you find code that you think is a good fit to add to PowerShell,
360
360
file an issue and start a discussion before proceeding.
361
361
* Create and/or update tests when making code changes.
362
-
* Run tests and ensure they are passing before pull request.
362
+
* Run tests and ensure they are passing before opening a pull request.
363
363
* All pull requests **must** pass CI systems before they can be approved.
364
364
* Avoid making big pull requests.
365
365
Before you invest a large amount of time,
@@ -368,7 +368,7 @@ is also appropriate, as is using Markdown syntax.
368
368
## Contributor License Agreement (CLA)
369
369
370
370
To speed up the acceptance of any contribution to any PowerShell repositories,
371
-
you should to [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) ahead of time.
371
+
you should sign the Microsoft [Contributor License Agreement (CLA)](https://cla.microsoft.com/) ahead of time.
372
372
If you've already contributed to PowerShell or Microsoft repositories in the past, congratulations!
373
373
You've already completed this step.
374
374
This a one-time requirement for the PowerShell project.
@@ -395,8 +395,10 @@ Once you sign a CLA, all your existing and future pull requests will have the st
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/Bug_Report.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,29 +16,29 @@ This repository is **ONLY** for PowerShell Core 6 and PowerShell 7+ issues.
16
16
- Make sure you are able to repro it on the [latest released version](https://github.com/PowerShell/PowerShell/releases)
17
17
- Search the existing issues.
18
18
- Refer to the [FAQ](https://github.com/PowerShell/PowerShell/blob/master/docs/FAQ.md).
19
-
- Refer to the [known issues](https://docs.microsoft.com/powershell/scripting/whats-new/known-issues-ps6?view=powershell-6).
19
+
- Refer to the [known issues](https://docs.microsoft.com/powershell/scripting/whats-new/known-issues-ps6).
- Snap - Please file issue in https://github.com/powershell/powershell-snap. This issues type is unrelated to snap packages with a distribution neutral.
19
+
- Processor Architecture (One per request):
15
20
-[ ]**Required** - An issues has been filed to create a Docker image in https://github.com/powershell/powershell-docker
16
21
- The following is a requirement for supporting a distribution **without exception.**
17
-
-[ ] The version and architecture of the Distribution is [supported by .NET Core](https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md#linux).
22
+
-[ ] The version and architecture of the Distribution is [supported by .NET Core](https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md#linux).
18
23
- The following are requirements for supporting a distribution.
19
-
Please write a justification for any exception where these criteria are not met and
20
-
the PowerShell comittee will review the request.
21
-
-[ ] The version of the Distribution is supported for at least one year.
22
-
-[ ] The version of the Distribution is not an [interim release](https://ubuntu.com/about/release-cycle) or equivalent.
24
+
Please write a justification for any exception where these criteria are not met and
25
+
the PowerShell committee will review the request.
26
+
-[ ] The version of the Distribution is supported for at least one year.
27
+
-[ ] The version of the Distribution is not an [interim release](https://ubuntu.com/about/release-cycle) or equivalent.
0 commit comments