-
Notifications
You must be signed in to change notification settings - Fork 904
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* stable: (26 commits) (maint) COMMITTERS - EOL change to CRLF (doc) update CONTRIBUTING/COMMITTERS (GH-1241) XmlService - trace logging information (maint) formatting (GH-1241) FileSystem - move file creates directory (GH-1241) Explicitly handle closing (maint) formatting (GH-1292) Ensure manifest extracted on unpackself (log) replace_file use new lines for log (maint) update CHANGELOG / nuspec (maint) nuspec - add info links to description (maint) clean up lib nuspec (GH-1311) Install-ChocolateyPowershellCommand File/FileFullPath aliases (GH-1284) ensure file/filefullpath on functions (maint) ReadMe updates (GH-1241) Use process id with update file (maint) restrict list start/end messages to log file (GH-1309) Restrict trace output (GH-1241) More Robust File.Replace (GH-1241) Use write_file for stream writing ... # Conflicts: # CONTRIBUTING.md # README.md
- Loading branch information
Showing
24 changed files
with
730 additions
and
247 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,88 @@ | ||
| Committers | ||
| ============ | ||
|
|
||
| ## Branch Targeting | ||
|
|
||
| * Stable currently targeting 0.9.9.x | ||
| * Master currently targeting 0.9.10.x | ||
|
|
||
| Depending on where your fix/enhancement goes, please target the proper branch. Community members always target master, but committers should know where the fix they are presenting goes. It makes it much easier to push the shiny green button on a pull request. If you are not sure where to target, ask. | ||
|
|
||
| ## Summary | ||
|
|
||
| We like to see folks contributing to Chocolatey. If you are a committer, we'd like to see you help from time to time with triage and the pull request process. | ||
|
|
||
| In all cases politeness goes a long way. Please thank folks for contributions - they are going out of their way to help make the code base better, or adding something they may personally feel is necessary for the code base. | ||
|
|
||
| Please be VERY familiar with [CONTRIBUTING](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and follow the process as well. | ||
|
|
||
| ## Terminology | ||
|
|
||
| **contributor** - A person who makes a change to the code base and submits a change set in the form of a pull request. | ||
|
|
||
| **change set** - A set of discrete commits which combined together form a contribution. A change set takes the form of git commits and is submitted in the form of a pull request. Used interchangeably with "pull request". | ||
|
|
||
| **committer** - A person responsible for reviewing a pull request and then making the decision what base branch to merge the change set into. | ||
|
|
||
| ## Review Process | ||
|
|
||
| #### Receive new PR (pull request) | ||
|
|
||
| * A contributor sends a pull request (usually against master). | ||
| * A committer typically reviews it within a week or less to determine the feasibility of the changes. | ||
|
|
||
| #### Initial PR Review | ||
|
|
||
| * Has the user signed the Contributor License Agreement (CLA)? | ||
| * Did the user create a branch with these changes? If it is on their master, please ask them to review [CONTRIBUTING](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md). | ||
| * Did the user reformat files and they should not have? Was is just white-space? You can try adding [?w=1](https://github.com/blog/967-github-secrets) to the URL on GitHub. | ||
| * Are there tests? We really want any new contributions to contain tests so unless the committer believes this code really needs to be in the code base and is willing to write the tests, then we need to ask the contributor to make a good faith effort in adding test cases. Ask them to review the [contributing document](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and provide tests. **Note:** Some commits may be refactoring which wouldn't necessarily add additional test sets. | ||
| * Is the code documented properly? Does this additional set of changes require changes to the [wiki](https://github.com/chocolatey/choco/wiki)? | ||
| * Was this code warranted? Did the contributor follow the process of gaining approval for big change sets? If not please have them review the [contributing document](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and ask that they follow up with a case for putting the code into the code base on the mailing list. | ||
|
|
||
| #### Review the Code | ||
| * Does the code meet the naming conventions and formatting (need link)? | ||
| * Is the code sound? Does it read well? Can you understand what it is doing without having to execute it? Principal of no clever hacks (need link). | ||
| * Does the code do what the purpose of the pull request is for? | ||
|
|
||
| #### Accepting a PR | ||
|
|
||
| Once you have reviewed the initial items, and are not waiting for additional feedback or work by the contributor, give the thumbs up that it is ready for the next part of the process (merging). | ||
|
|
||
| Unless there is something wrong with the code, we don't ask contributors to rebase against master. They did the work to create the patch in the first place, asking them to unnecessarily come back and try to keep their code synced up with master is not an acceptable process. | ||
|
|
||
| ## Merging | ||
|
|
||
| Once you have reviewed the change set and determined it is ready for merge, the next steps are to bring it local and evaluate the code further by actually working with it, running the tests locally and adding any additional commits or fix-ups that are necessary in a local branch. | ||
|
|
||
| When merging the user's contribution, it should be done with `git merge --log --no-ff` to create a merge commit so that in case there is an issue it becomes easier to revert later, and so that we can see where the code came from should we ever need to go find it later (more information on this can be found [here](https://www.kernel.org/pub/software/scm/git/docs/git-merge.html) and also a discussion on why this is a good idea [here](http://differential.io/blog/best-way-to-merge-a-github-pull-request)). | ||
|
|
||
| ### Merge Retargeting to Stable | ||
|
|
||
| Because we ask contributors to target master, sometimes a fix/enhancement may need to be retargeted to stable. This process is somewhat easy thanks to git. In most cases you won't even need to ask the user to do this for you. | ||
|
|
||
| * Add the user's remote. | ||
| * `git fetch user` | ||
| * `git checkout branch_from_user` | ||
| * `git rebase --onto stable master` - this uses the local branch, starts with latest stable and reapplies the commits from the branch to it, removing all commits that were only on the master. | ||
| * `build.bat` - build and test | ||
| * `git checkout stable` | ||
| * `git merge branch_from_user --log --no-ff` | ||
| * `git branch -d branch_from_user` | ||
|
|
||
| References | ||
|
|
||
| * http://pivotallabs.com/git-rebase-onto/ | ||
| * http://git-scm.com/book/ch3-6.html | ||
| Committers | ||
| ============ | ||
|
|
||
| <!-- TOC --> | ||
|
|
||
| - [Branch Targeting](#branch-targeting) | ||
| - [Summary](#summary) | ||
| - [Terminology](#terminology) | ||
| - [Review Process](#review-process) | ||
| - [Receive new PR (pull request)](#receive-new-pr-pull-request) | ||
| - [Initial PR Review](#initial-pr-review) | ||
| - [Review the Code](#review-the-code) | ||
| - [Accepting a PR](#accepting-a-pr) | ||
| - [Merging](#merging) | ||
| - [Merge Retargeting to Stable](#merge-retargeting-to-stable) | ||
|
|
||
| <!-- /TOC --> | ||
|
|
||
| ## Branch Targeting | ||
| * Stable currently targeting 0.10.x | ||
| * Master currently targeting 0.11.x | ||
|
|
||
| **NOTE:** The above may be out of date. The best way to determine what branch is being targeted for stable is to run `git describe`. Stable and master are typically different on minor version (`x.y.z` - the `y`). | ||
|
|
||
| Depending on where your fix/enhancement goes, please target the proper branch. Community members always target master, but committers should know where the fix they are presenting goes. It makes it much easier to push the shiny green button on a pull request. If you are not sure where to target, ask. | ||
|
|
||
| ## Summary | ||
| We like to see folks contributing to Chocolatey. If you are a committer, we'd like to see you help from time to time with triage and the pull request process. | ||
|
|
||
| In all cases politeness goes a long way. Please thank folks for contributions - they are going out of their way to help make the code base better, or adding something they may personally feel is necessary for the code base. | ||
|
|
||
| Please be VERY familiar with [CONTRIBUTING](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and follow the process as well. | ||
|
|
||
| ## Terminology | ||
| **Contributor** - A person who makes a change to the code base and submits a change set in the form of a pull request. | ||
|
|
||
| **Change Set** - A set of discrete commits which combined together form a contribution. A change set takes the form of git commits and is submitted in the form of a pull request. Used interchangeably with "pull request". | ||
|
|
||
| **Committer** - A person responsible for reviewing a pull request and then making the decision what base branch to merge the change set into. | ||
|
|
||
| ## Review Process | ||
| #### Receive new PR (pull request) | ||
| * A contributor sends a pull request (usually against master). | ||
| * A committer typically reviews it within a week or less to determine the feasibility of the changes. | ||
|
|
||
| #### Initial PR Review | ||
| * Has the user signed the Contributor License Agreement (CLA)? | ||
| * Did the user create a branch with these changes? If it is on their master, please ask them to review [CONTRIBUTING](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md). | ||
| * Did the user reformat files and they should not have? Was is just white-space? You can try adding [?w=1](https://github.com/blog/967-github-secrets) to the URL on GitHub. | ||
| * Are there tests? We really want any new contributions to contain tests so unless the committer believes this code really needs to be in the code base and is willing to write the tests, then we need to ask the contributor to make a good faith effort in adding test cases. Ask them to review the [contributing document](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and provide tests. **Note:** Some commits may be refactoring which wouldn't necessarily add additional test sets. | ||
| * Is the code documented properly? Does this additional set of changes require changes to the [wiki](https://github.com/chocolatey/choco/wiki)? | ||
| * Was this code warranted? Did the contributor follow the process of gaining approval for big change sets? If not please have them review the [contributing document](https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md) and ask that they follow up with a case for putting the code into the code base on the mailing list. | ||
|
|
||
| #### Review the Code | ||
| * Does the code meet the naming conventions and formatting (need link)? | ||
| * Is the code sound? Does it read well? Can you understand what it is doing without having to execute it? Principal of no clever hacks (need link). | ||
| * Does the code do what the purpose of the pull request is for (and only that)? | ||
|
|
||
| #### Accepting a PR | ||
| Once you have reviewed the initial items, and are not waiting for additional feedback or work by the contributor, give the thumbs up that it is ready for the next part of the process (merging). | ||
|
|
||
| Unless there is something wrong with the code, we don't ask contributors to rebase against master. They did the work to create the patch in the first place, asking them to unnecessarily come back and try to keep their code synced up with master is not an acceptable process. | ||
|
|
||
| ## Merging | ||
| Once you have reviewed the change set and determined it is ready for merge, the next steps are to bring it local and evaluate the code further by actually working with it, running the tests locally and adding any additional commits or fix-ups that are necessary in a local branch. | ||
|
|
||
| When merging the user's contribution, it should be done with `git merge --log --no-ff` to create a merge commit so that in case there is an issue it becomes easier to revert later, and so that we can see where the code came from should we ever need to go find it later (more information on this can be found [here](https://www.kernel.org/pub/software/scm/git/docs/git-merge.html) and also a discussion on why this is a good idea [here](http://differential.io/blog/best-way-to-merge-a-github-pull-request)). | ||
|
|
||
| ### Merge Retargeting to Stable | ||
| Because we ask contributors to target master, sometimes a fix/enhancement may need to be retargeted to stable. This process is somewhat easy thanks to git. In most cases you won't even need to ask the user to do this for you. | ||
|
|
||
| * `git fetch upstream pull/<github_pull_id>/head:pr<github_pull_id>` - `upstream` is `[email protected]:chocolatey/choco.git` | ||
| * `git checkout pr<github_pull_id>` | ||
| * `git rebase --onto stable master` - this uses the local branch, starts with latest stable and reapplies the commits from the branch to it, removing all commits that were only on the master. | ||
| * `build.bat` - build and test | ||
| * `git checkout stable` | ||
| * Any addtional changes or testing here. | ||
| * `git merge pr<github_pull_id> --log --no-ff` | ||
| * `git branch -d pr<github_pull_id>` | ||
| * `git checkout master` | ||
| * `git merge stable` | ||
| * Make any last checks to ensure the git logs look good. The next step sets the commits in stone and unable to be changed. | ||
| * `git push upstream` | ||
|
|
||
| References | ||
|
|
||
| * http://pivotallabs.com/git-rebase-onto/ | ||
| * http://git-scm.com/book/ch3-6.html |
Oops, something went wrong.