Skip to content

Add document for cleaning up commits in a pull request #2863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 30, 2016

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Aug 30, 2016

Also changed pull request template to include a section for comments at the top, include a note about removing unused check boxes, and include a link to the commit document.

Fix for issue #2843


This checklist is used to make sure that common issues in a pull request are covered by the creator. You can find a more complete discussion of PowerShell cmdlet best practices here.

Below in Overall Changes, check off the boxes that apply to your PR. Within each of the categories that you select, make sure that you can check off all of the boxes.

Overall Changes

General

  • Title of the PR is clear and informative
  • There are a small number of commits that each have an informative message
  • If it applies, references the bug/issue that the PR fixes
  • All files have the Microsoft copyright header
  • Cmdlets refer to management libraries through nuget references - no dlls are checked in
  • The PR does not introduce breaking changes (unless a major version change occurs in the assembly and module)


### Rebasing

Sometimes a pull request can be based on a much earlier commit in the branch that you are trying to merge into it, causing a large amount of commits and file changes to litter the pull request. In this case, it would be better to **rebase** (move branches around by changing the commit that they are based on). After rebasing, you will want to close the pull request and open a new one, which will now have less commits.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

less commits -> fewer commits

@markcowl
Copy link
Member

@cormacpayne a couple of nits, this looks really good.

@cormacpayne
Copy link
Member Author

@markcowl resolved review comments

@cormacpayne
Copy link
Member Author

@azuresdkci test this please

@markcowl markcowl merged commit 5cdc1c8 into Azure:dev Aug 30, 2016
@cormacpayne cormacpayne deleted the commit-doc branch September 13, 2016 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants