aphrody-labs/PowerShell
1
0 Fork 0
mirror of https://github.com/aphrody-labs/PowerShell.git synced 2026-10-17 04:36:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update submodules.md

Browse Source 
Added newlines.
This commit is contained in:
Aleksandar Nikolić authored and GitHub committed 2016-07-17 15:21:13 +02:00
1 parent 58bbfe0dec
commit 23a6fce8b0
1 file changed
+10 -15
Download Patch File Download Diff File Expand all files Collapse all files
docs/git/submodules.md
+10 -15
View File
@@ -1,9 +1,8 @@
Submodules Submodules
========== ==========
While most developers will not have to deal with submodules on a While most developers will not have to deal with submodules on a regular basis, those who do should read this information.
regular basis, those who do should read this information. The The submodules currently in this project are:
submodules currently in this project are:
- `src/Modules/Pester`: The Pester testing framework for PowerShell - `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!* *This is not necessary in the superproject, only submodules!*
**DO NOT** commit updates unless absolutely necessary. When submodules **DO NOT** commit updates unless absolutely necessary.
must be updated, a separate Pull Request must be submitted, reviewed, When submodules must be updated, a separate Pull Request must be submitted, reviewed, and merged before updating the superproject.
and merged before updating the superproject.
Because GitHub's "Merge Pull Request" button merges with `--no-ff`, an Because GitHub's "Merge Pull Request" button merges with `--no-ff`, an extra merge commit will always be created.
extra merge commit will always be created. This is especially annoying This is especially annoying when trying to commit updates to submodules.
when trying to commit updates to submodules. Therefore our policy is Therefore our policy is to merge using the Git CLI after approval, with a rebase onto master to enable a fast-forward merge.
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 When committing submodule updates, ensure no other changes are in the same commit.
same commit. Submodule bumps may be included in feature branches for Submodule bumps may be included in feature branches for ease of work,
ease of work, but the update must be independently approved before but the update must be independently approved before merging into master.
merging into master.