search

OrchardCMS / OrchardDoc

Documentation for Orchard 1.x (not Orchard Core, for that see https://docs.orchardcore.net/).
http://docs.orchardproject.net
142 stars 241 forks source link

Integrate the concept of squashing PRs down to a single commit into the docs #234

Closed rtpHarry closed 8 years ago

rtpHarry commented 8 years ago

The documentation should make it clear that you need to squash your commits to keep things clean. It looks like when the repo was on CodePlex this was handled by the team.

The "contributing patches" has a mention of it which needs amending and cross linking to "merging pull requests".

The "merging pull requests" needs to be updated for GitHub and made clear that it's the developer that creates the PR that needs to keep their branch clean.

rtpHarry commented 8 years ago

When podcast Tuesday 23rd Feb 2016 is published on YouTube then add a link to this at around 51 minutes deep.

Sebastienros did a video presentation explaining how to do the squash without having to use the cumbersome squash ui (you do a reset branch back to the first commit and then choose the mixed mode so it keeps your changes, then you can commit everything again in one go and the history to keep it clean)

rtpHarry commented 8 years ago

Video is here:

agriffard commented 8 years ago

GitHub now allow to squash PR automatically on merge.