diff --git a/docs/git/submodules.md b/docs/git/submodules.md index 2b90e3ed28..0395527440 100644 --- a/docs/git/submodules.md +++ b/docs/git/submodules.md @@ -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.