maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #1398 from alexandair/patch-1

Browse source 
Update submodules.md
This commit is contained in:
Sergei Vorobev 2016-07-20 15:46:13 -07:00 committed by GitHub
parent 76b136d393 23a6fce8b0
commit 1d89eb9c89
1 changed files with 10 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/git/submodules.md
View file

@ -1,9 +1,8 @@
Submodules
==========
While most developers will not have to deal with submodules on a
regular basis, those who do should read this information. The
submodules currently in this project are:
While most developers will not have to deal with submodules on a regular basis, those who do should read this information.
The submodules currently in this project are:
- `src/Modules/Pester`: The Pester testing framework for PowerShell
@ -17,17 +16,13 @@ Rebase and Fast-Forward Merge Pull Requests in Submodules
*This is not necessary in the superproject, only submodules!*
**DO NOT** commit updates unless absolutely necessary. When submodules
must be updated, a separate Pull Request must be submitted, reviewed,
and merged before updating the superproject.
**DO NOT** commit updates unless absolutely necessary.
When submodules must be updated, a separate Pull Request must be submitted, reviewed, and merged before updating the superproject.
Because GitHub's "Merge Pull Request" button merges with `--no-ff`, an
extra merge commit will always be created. This is especially annoying
when trying to commit updates to submodules. Therefore our policy is
to merge using the Git CLI after approval, with a rebase onto master
to enable a fast-forward merge.
Because GitHub's "Merge Pull Request" button merges with `--no-ff`, an extra merge commit will always be created.
This is especially annoying when trying to commit updates to submodules.
Therefore our policy is to merge using the Git CLI after approval, with a rebase onto master to enable a fast-forward merge.
When committing submodule updates, ensure no other changes are in the
same commit. Submodule bumps may be included in feature branches for
ease of work, but the update must be independently approved before
merging into master.
When committing submodule updates, ensure no other changes are in the same commit.
Submodule bumps may be included in feature branches for ease of work,
but the update must be independently approved before merging into master.