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: .github/CONTRIBUTING.md
+106-45
Original file line number
Diff line number
Diff line change
@@ -2,62 +2,107 @@ Contribute to PowerShell
2
2
=================================
3
3
4
4
We welcome and appreciate contributions from the community. There are many ways to become involved with PowerShell, including filing issues, joining in design conversations,
5
-
writing and improving documentation, contributing to code. Please read the rest of this document to ensure a smooth contribution process.
5
+
writing and improving documentation, contributing to the code. Please read the rest of this document to ensure a smooth contribution process.
6
6
7
7
New to Git?
8
8
----
9
9
- Make sure you have a [GitHub account](https://github.com/signup/free)
10
-
-[Git Basics](../docs/git/basics.md): install and getting started.
10
+
- Learning Git:
11
+
* GitHub Help: [Good Resources for Learning Git and GitHub][good-git-resources]
12
+
*[Git Basics](../docs/git/basics.md): install and getting started.
13
+
* PowerShell DSC Resources: [Getting Started With GitHub](https://github.com/PowerShell/DscResources/blob/master/GettingStartedWithGitHub.md)
11
14
-[GitHub Flow Guide](https://guides.github.com/introduction/flow/): step-by-step instructions of GitHub flow.
12
15
13
-
14
16
Quick Start Check-list
15
17
----
16
-
- Read [the Community Governance](../docs/community/governance.md)
17
-
- Make sure you have signed a [PowerShell Contribution License Agreement (CLA)](#contributor-license-agreement) before submitting a pull request
18
+
- Review the [Contribution License Agreement][CLA] requriement.
18
19
- Get familiar with the [PowerShell repository](../docs/git/powershell-repository-101.md)
19
20
20
21
Contributing to Issues
21
22
----
22
23
23
-
- Review the [GitHub issue management process](../docs/dev-process/issue-management-process.md). It covers the triage process and the definition of labels and assignees as well as a description of how we will verify and close issues
24
-
- Check if the issue you are going to file already exists in our [GitHub issues](https://github.com/PowerShell/PowerShell/issues)
24
+
- Review the [Issue Label Descriptions](../docs/dev-process/issue-label-descriptions.md)
25
+
- Check if the issue you are going to file already exists in our [GitHub issues][open-issues]
25
26
- If you can't find your issue already, [open a new issue](https://github.com/PowerShell/PowerShell/issues/new), making sure to follow the directions in the issue template as best you can.
27
+
- If the issue is marked as [`Help Wanted`][help-wanted-issue], the issue team is looking for help with the issue.
26
28
27
29
Contributing to Documentation
28
30
----
29
-
- First, check the list of [documentation issues](https://github.com/PowerShell/PowerShell-Docs/issues) to make sure your issue doesn't already exist or that someone is already working on it.
30
-
- If you cannot find an existing issue for your desired work, [open a new issue](https://github.com/PowerShell/PowerShell/issues/new) explaining that you'd like to contribute to fix the problem.
31
-
- Follow the guidelines at [Contributing to PowerShell Documentation](https://github.com/PowerShell/PowerShell-Docs/blob/staging/CONTRIBUTING.md).
32
-
- If you contribute to the PowerShell project in a way that changes the user or developer experience, you are expected to document those changes.
33
-
- When you are writting markdown docs, use [semantic linefeeds](http://rhodesmill.org/brandon/2012/one-sentence-per-line/).
34
-
In most cases, it means "once sentance per line".
31
+
### Contributing to documentation related to the PowerShell the product
32
+
33
+
Please see the [Contributor Guide in `PowerShell/PowerShell-Docs`](https://github.com/PowerShell/PowerShell-Docs/blob/staging/CONTRIBUTING.md).
34
+
35
+
### Contributing to documentation related to Contributing or maintaining the PowerShell Project
36
+
37
+
These issues should be treated like any other issue in this repo. See [Contribuing to Code](#contributing-to-code).
35
38
36
39
Contributing to Code
37
40
----
38
41
39
-
- Learn how to setup your development environment and build PowerShell for [Linux][build-linux], [Windows Core][build-wc], [Windows Full][build-wf] or
40
-
[OS X][build-osx].
41
-
- Build the [PowerShell repository](https://github.com/PowerShell/PowerShell)
42
-
- Ensure you can [locally execute tests][testing-guidelines] with your build.
43
-
-[Pick something to work on](https://github.com/PowerShell/PowerShell/issues)
44
-
- If you cannot find an existing issue for your desired work, open a new issue for your work
45
-
- Get agreement from the PowerShell team and the community regarding your proposed change via the [issue triage process][issue-triage].
46
-
- If you're changes require a new cmdlet or other design changes, follow the [design change guidelines](#making-design-changes)
47
-
- Ensure that you've reviewd our [breaking changes guidelines](#making-breaking-changes)
48
-
- If you would like to be assigned to the issue, please ask `@powershell/powershell` for an assignment
49
-
- Create a [personal fork of the repository](https://help.github.com/articles/fork-a-repo/) to start your work
50
-
- Follow the [coding guidelines](../docs/coding-guidelines/coding-guidelines.md) and [testing guidelines](../docs/testing-guidelines/testing-guidelines.md)
51
-
- Read the [Pull Request (PR) Guidelines](../docs/dev-process/pull-request-rules.md) and create a [PR](https://guides.github.com/activities/hello-world/) against the upstream repository
52
-
- Perform a [code review](../docs/dev-process/code-review-guidelines.md) with the [PowerShell Committee][governance] on the pull request.
Please see [Building PowerShell](../README.md#building-powershell)
45
+
#### Testing PowerShell
46
+
Please see PowerShell [Testing Guidelines - Running Tests Outside of CI][running-tests-outside-of-ci] on how to test you build locally.
47
+
48
+
### Finding or creating an issue
49
+
50
+
1. Follow the instructions in [Contributing to Issues][contribute-issues] to find or open an issue.
51
+
2. Mention in the issue that you are working on the issue and ask `@powershell/powershell` for an assignment.
52
+
53
+
### Forks and Pull Requests
54
+
55
+
GitHub fosters collaboration through the notion of [pull requests][using-prs].
56
+
On GitHub, anyone can [fork][fork-a-repo] an existing repository into their own branch where they can make private changes to the original repository.
57
+
To contribute these changes back into the original repository, a user simply creates a pull request in order to "request" that the changes be taken "upstream".
58
+
59
+
Additional references:
60
+
* GitHub's guide on [forking project](https://guides.github.com/activities/forking/)
61
+
* GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
62
+
* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
63
+
64
+
65
+
### Lifecycle of a pull request
66
+
67
+
#### Pull request submission
68
+
**Always create a pull request to the `master` branch of this repository**.
69
+
For more information, learn about our [branch structure][branch-structure].
70
+
71
+
72
+
73
+
* Add a meaningful title of the PR describing what change you want to check in. Don't simply put: "Fixes issue #5". A better example is: "Added Ensure parameter to New-Item CmdLet. Fixes #5".
74
+
75
+
* When you create a pull request, fill out the pull request template including a summary of what's included in your changes.
76
+
If the changes are related to an existing GitHub issue, please reference the issue in pull request title or description (e.g. ```Closes #11```). See [this][closing-via-message] for more details.
77
+
78
+
* Include an update to the [change log](../CHANGELOG.MD) file in your pull request to reflect changes for future versions changelog. Put them in `Unreleased` section (create one if doesn't exist). This would simplify the release process for [maintainers][maintainers]. Example:
79
+
```
80
+
## Versions
81
+
82
+
### Unreleased
83
+
84
+
- Added support for `-FriendlyName` in `Update-Item`.
85
+
```
86
+
Please use past tense when describing your changes:
87
+
88
+
* Instead of "Adding support for Windows Server 2012 R2", write "Added support for Windows Server 2012 R2".
89
+
90
+
* Instead of "Fix for server connection issue", write "Fixed server connection issue".
91
+
92
+
Also, if change is related to specific resource, please prefix the description with the resource name:
93
+
94
+
* Instead of "New parameter 'ConnectionCredential' in New-SqlConnection", write "New-SqlConnection: added parameter 'ConnectionCredential'"
95
+
96
+
#### Pull request - Automatic checks
97
+
98
+
* If this is your first contribution to PowerShell, you may be asked to sign a [Contribution Licensing Agreement][CLA] (CLA) before your changes will be accepted.
99
+
* Make sure you follow the [Common Engineering Practices](#common-engineering-practices) and [testing guidelines](../docs/testing-guidelines/testing-guidelines.md)
100
+
* After submitting your pull request, our [CI system (Travis-CI & Appveyor)][ci-system] will run a suite of tests and automatically update the status of the pull request.
101
+
102
+
#### Pull request - Code review
103
+
104
+
* After a successful test pass, the area [maintainers][maintainers] will do a code review, commenting on any changes that might need to be made. If you are not designated as an area's [maintainer][maintainers], feel free to review others' Pull Requests as well. Additional feedback is always welcome (leave your comments even if everything looks good - simple "Looks good to me" or "LGTM" will suffice so that we know someone has already taken a look at it)!
105
+
* Once the code review is done, all merge conflicts are resolved, and the CI system build status is passing, a [maintainer][maintainers] will merge your changes.
61
106
62
107
Making Breaking Changes
63
108
----
@@ -68,14 +113,14 @@ and follow the guidelines to keep PowerShell backward compatible.
68
113
69
114
Making Design Changes
70
115
----
71
-
To add new features such as cmdlets or making design changes, please follow the [PowerShell Request for Comments (RFC)](https://github.com/PowerShell/PowerShell-RFC) process.
116
+
To add new features such as CmdLets or making design changes, please follow the [PowerShell Request for Comments (RFC)](https://github.com/PowerShell/PowerShell-RFC) process.
72
117
73
118
Common Engineering Practices
74
119
----
75
-
Other than the guidelines for ([coding](../docs/coding-guidelines/coding-guidelines.md), the [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design, [documentation](#contributing-to-documentation)
120
+
Other than the guidelines for ([coding](../docs/coding-guidelines/coding-guidelines.md),
121
+
the [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design, [documentation](#contributing-to-documentation)
76
122
and [testing](../docs/testing-guidelines/testing-guidelines.md)) discussed above, we encourage contributors to follow these common engineering practices:
77
-
- Do not commit code changes to the `master` branch!
78
-
Read GitHub's guides on [forking project](https://guides.github.com/activities/forking/) and [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
123
+
79
124
- Format commit messages based on [Tim Pope's guidelines]("http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"):
80
125
81
126
```
@@ -85,8 +130,7 @@ Provide more detail after the first line. Leave one blank line below the
85
130
summary and wrap all lines at 72 characters or less.
86
131
87
132
If the change fixes an issue, leave another blank line after the final
88
-
paragraph and indicate which issue is fixed in the specific format
89
-
below.
133
+
paragraph and indicate which issue the change fixes in the specific format below.
90
134
91
135
Fix #42
92
136
```
@@ -113,9 +157,26 @@ You can find more information about the PowerShell source license and copyright
113
157
114
158
Contributor License Agreement (CLA)
115
159
----
116
-
You must sign a PowerShell Contribution License Agreement (CLA) before your pull request will be merged.
117
-
This a one-time requirement for the PowerShell project. Signing the CLA process is simple and can be done in less than a minute.
118
-
You don't have to do this up-front. You can simply clone, fork, and submit your pull request as usual.
160
+
161
+
To speed up the acceptance of any contribution to any PowerShell repositories, you could [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) ahead of time.
162
+
If you've already contributed to PowerShell repositories in the past, congratulations! You've already completed this step. This a one-time requirement for the PowerShell project.
163
+
Signing the CLA process is simple and can be done in less than a minute. You don't have to do this up-front. You can simply clone, fork, and submit your pull request as usual.
119
164
When your pull request is created, it is classified by a CLA bot.
120
165
If the change is trivial, it's classified as `cla-required`.
121
-
Once you sign a CLA, all your existing and future pull requests will be labeled as cla-signed.
166
+
Once you sign a CLA, all your existing and future pull requests will be labeled as `cla-signed`.
| Build from **Source**|[Instructions][build-linux]|[Instructions][build-wc]|[Instructions][build-osx]|
54
53
55
-
To begin development, you'll need to setup your development environment for [Linux][build-linux], [Windows][build-wc], or
56
-
[OS X][build-osx] and are encouraged to review the
57
-
[contribution guidelines][contribution] for specific workflow, test
58
-
requirements and coding guidelines.
54
+
Developing and Contributing
55
+
--------------------------
56
+
To begin development, you'll need to setup your development environment for [Linux][build-linux], [Windows Core][build-wc], [Windows Full][build-wf] or
59
57
60
58
If you encounter issues in your development, please consult the [known issues][known-issues]
61
59
and [FAQ][faq] documents to see if the issue you are running into is
@@ -64,8 +62,6 @@ captured and if a workaround exists.
64
62
If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues].
65
63
If you do not see your issue captured, please file a [new issue][new-issue] using the appropriate issue tag.
0 commit comments