Win7/PowerShell7
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

"Updated to address the feedback".

Browse Source 
[skip ci]
This commit is contained in:
Jianyun Tao 2016-06-24 10:34:32 -07:00
parent e35b5ceb34
commit 2febe943c8
1 changed files with 66 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
.github/CONTRIBUTING.md vendored
View File

@ -3,64 +3,70 @@
We love to have contributions from you! There are several ways to contribute such as filing issues, joining in design conversations, We love to have contributions from you! There are several ways to contribute such as filing issues, joining in design conversations,
documentation, contributing to code. To keep this process smooth, there are a few guidelines mentioned below for contributors to follow. documentation, contributing to code. To keep this process smooth, there are a few guidelines mentioned below for contributors to follow.
PowerShell team will be happy to explain the guidelines via Github Issue if you have questions.
##New to Git?## New to Git?
----
- Make sure you have a [GitHub account](https://github.com/signup/free) - Make sure you have a [GitHub account](https://github.com/signup/free)
- [Git Basics](../docs/git/basics.md): install and getting started. - [Git Basics](../docs/git/basics.md): install and getting started.
- [Commit process](../docs/git/committing.md): sstep-by-step instructions how to commit your changes - [Commit process](../docs/git/committing.md): step-by-step instructions how to commit your changes
- [Git for sd users](../docs/git/source-depot.md): a handy reference - [Git for sd users](../docs/git/source-depot.md): a handy reference document for
document for people familiar with `sd` people familiar with `sd`
##Quick Start Check-list##
- Read [the Community Governance] (community/governance.md)
- Make sure you have signed [PowerShell Contribution License Agreement (CLA)]("Contributor License Agreement") before pull request
- Get familar with the [PowerShell repository structure](dev-process/build/branch-structure.md)
- Setup your [development environment] (dev-process/setup/setup-dev-environment.md)
- Build the [PowerShell repository] (../readme.md)
- [Try it out with the binaries you just built] (try-out.md)
##Contributing to Issues## Quick Start Check-list
----
- Read [the Community Governance](../docs/community/governance.md)
- Make sure you have signed [PowerShell Contribution License Agreement (CLA)](#Contributor-License-Agreement) before pull request
- Get familiar with the [PowerShell repository structure](../docs/dev-process/build/branch-structure.md)
- Setup your [development environment](../docs/dev-process/setup/setup-dev-environment.md)
- Build the [PowerShell repository](../readme.md)
- [Try it out with the binaries you just built](../docs/try-out.md)
- Review the [Github Issue Management process](dev-process/issue-management-process.md). It covers the definition of Label, Assignee
and the guidance like verifying and closing issues Contributing to Issue
----
- Review the [Github Issue Management process](../docs/dev-process/issue-management-process.md). It covers our triage process and the definition of Label, Assignee and the guidance like verifying and closing issues
- Check if the issue you are going to file already exists in [GitHub Issue query](https://github.com/PowerShell/PowerShell/issues) - Check if the issue you are going to file already exists in [GitHub Issue query](https://github.com/PowerShell/PowerShell/issues)
- Submit an issue, assuming it does not exist yet, via [GitHub Issue track](https://github.com/PowerShell/PowerShell/issues) by following the [Issue template] (issue-template.md). - Submit an issue, assuming it does not exist yet, via [GitHub Issue track](https://github.com/PowerShell/PowerShell/issues) by following the issue template.
##Contributing to Documentation## Contributing to Documentation
----
- TODO: Don will fill in the details - TODO: Don will fill in the details
##Contributing to Code## Contributing to Code
----
- [Pick something to work on] (https://github.com/PowerShell/PowerShell/issues) - [Pick something to work on](https://github.com/PowerShell/PowerShell/issues)
- If what you want to work on does not exist in the query, create an issue for your work - If what you want to work on does not exist in the query, create an issue for your work
- Get agreement from the PowerShell team and the community regarding your proposed change via the [Issue Triage Process](dev-process/issue-management-process.md). - Get agreement from the PowerShell team and the community regarding your proposed change via the [Issue Triage Process](../docs/dev-process/issue-management-process.md).
- If you will be adding a new cmdlet or other design changes, follow [Making Design Changes guidelines]("Making Design Changes") - If you will be adding a new cmdlet or other design changes, follow [Making Design Changes guidelines](#Making-Design-Changes)
- For breaking changes, see [Make Breaking Changes guidelines]("Making Breaking Changes") - For breaking changes, see [Make Breaking Changes guidelines](#Making-Breaking-Changes)
- The issue filer and the implementer don't have to be the same person. So clearly state when you create an issue that you will be the implementer, so the issue can be assigned to you - The issue filer and the implementer don't have to be the same person. So clearly state when you create an issue that you will be the implementer, so the issue can be assigned to you
- Create a [personal fork of the repository](https://help.github.com/articles/fork-a-repo/) or a [branch](https://guides.github.com/activities/hello-world/) to start your work - Create a [personal fork of the repository](https://help.github.com/articles/fork-a-repo/) to start your work
- Follow the [coding guidelines] (coding-guidelines/coding-guidelines.md) - Follow the [coding guidelines](../docs/coding-guidelines/coding-guidelines.md) and [testing guidelines](../docs/testing-requirements/test-guidelines.md)
- Ensure pass the [checkin tests] (testing-requirements/test-guidelines.md) for code changes - Create a [GitHub pull request (PR)](https://guides.github.com/activities/hello-world/) against the upstream repository
- Create a [GitHub pull request (PR)] (https://guides.github.com/activities/hello-world/)) against the upstream repository - Perform a [code review](../docs/dev-process/code-review-guidelines.md) with the PowerShell Committee (TODO) on the pull request.
- Perform a [code review] (dev-precess/code-review-guidelines.md) with the PowerShell Committee (TODO) on the pull request.
##Making Breaking Changes## Making Breaking Changes
----
When you make code changes, please pay attention to these that can affect the [Public Contract](dev-process/breaking-change-contract.md), When you make code changes, please pay attention to these that can affect the [Public Contract](../docs/dev-process/breaking-change-contract.md),
for example, PowerShell parameter, API or protocols changes. Before starting making changes to the code, first review the [Breaking Changes guidelines] (dev-process/breaking-change-contract.md) for example, PowerShell parameter, API or protocols changes. Before starting making changes to the code, first review the [Breaking Changes guidelines](../docs/dev-process/breaking-change-contract.md)
and follow the guidelines to keep PowerShell backward compatible. and follow the guidelines to keep PowerShell backward compatible.
##Making Design Changes## Making Design Changes
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. ----
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.
Common Engineering Practices
----
Other than the guidelines ([coding](../docs/coding-guidelines/coding-guidelines.md), [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design, [documentation]()
and [testing](../docs/testing-requirements/test-guidelines.md)) discussed above, following are common engineering practices we would like everyone to follow:
- Do not commit code changes to the master branch! You should [fork or checkout a branch](#Contributing-to-Code)
- Format commit messages as follows based on [the Tim Pope's guidelines]("http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"):
##Common Engineering Practices##
Other than the guidelines ([coding](coding-guidelines/coding-guidelines.md), [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design, [documetnation]() and [testing](testing-requirements/test-guidelines.md)) discussed above, following are common engineering practices we would like everyone to follow:
- Do not commit code changes to the master branch! You should [fork or checkout a branch]("Contributing to Code")
- Format commit messages as follows based on [the Tim Pope's guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html):
``` ```
Summarize change in 50 characters or less Summarize change in 50 characters or less
@ -73,27 +79,35 @@ below.
Fix #42 Fix #42
``` ```
- Don’t commit code that you didn't write. If you find code that you think is a good fit to add to PowerShell, file an issue and start a discussion before proceeding.
- Create and/or update tests when making code changes - Don't commit code that you didn't write. If you find code that you think is a good fit to add to PowerShell, file an issue and start a discussion before proceeding.
- Create and/or update tests when making code changes
- Run tests and ensure they are passing before pull request - Run tests and ensure they are passing before pull request
- All pull requests **must** pass CI systems before they can be approved - All pull requests **must** pass CI systems before they can be approved
- Avoid making a big pull requests. Instead, file an issue and start a discussion with the community before you invest a large amount of time. - Avoid making a big pull requests. Instead, file an issue and start a discussion with the community before you invest a large amount of time.
- Blog and tweet about your contributions, frequently! - Blog and tweet about your contributions frequently!
##File Headers## File Headers
----
The following file header is the used for PowerShell. Please use it for new files. For more information, see [coding guidelines](coding-guidelines/coding-guidelines.md). The following file header is the used for PowerShell. Please use it for new files. For more information, see [coding guidelines](coding-guidelines/coding-guidelines.md).
```C# ```C#
// … TODO TODO // … TODO TODO
// Licensed to the PowerShell …. under one or more agreements. // Licensed to the PowerShell …. under one or more agreements.
// See the LICENSE file in the project root for more information. // See the LICENSE file in the project root for more information.
``` ```
##Licensing & Copyright##
Licensing & Copyright
----
You can find [here]() for the PowerShell sources license and copyright information. You can find [here]() for the PowerShell sources license and copyright information.
##Contributor License Agreement## Contributor License Agreement
You must sign a PowerShell Contribution License Agreement (CLA) before your Pull Request will be merged. ----
This a one-time requirement for the PowerShell project. Signing the CLA process is simple and can be done in less than a minute. You must sign a PowerShell Contribution License Agreement (CLA) before your Pull Request will be merged.
This a one-time requirement for the PowerShell project. Signing the CLA process is simple and can be done in less than a minute.
You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on wikipedia. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on wikipedia.
You don't have to do this up-front. You can simply clone, fork, and submit your pull-request as usual. When your pull-request is created, it is classified by a CLA bot. If the change is trivial (e.g. you just fixed a typo), then the PR is labelled with cla-not-required. Otherwise it's classified as cla-required. Once you signed a CLA, the current and all future pull-requests will be labelled as cla-signed. You don't have to do this up-front. You can simply clone, fork, and submit your pull-request as
usual. When your pull-request is created, it is classified by a CLA bot. If the change is trivial
(e.g. you just fixed a typo), then the PR is labelled with cla-not-required. Otherwise it's
classified as cla-required. Once you signed a CLA, the current and all future pull-requests will be
labelled as cla-signed.