Update testing-guidelines.md to remind users about submodules #5061
Conversation
The bit about submodules in the README is easy to miss or forget if you're reading deep into the docs. It might be helpful to have a reminder here if someone is having trouble with the Pester module not being found.
|
We already have this in 4 files https://github.com/PowerShell/PowerShell/search?l=Markdown&q=git+submodule+&type=&utf8=%E2%9C%93 |
|
@iSazonov I think this one trips up enough people that it should also be included here. I have answered several DM's about testing fails due to this exact issue. It's not obvious, so we might as well be repetitive about it. |
|
I think "dry" principle is good for docs too. We plan remove submodules and already have removed some. |
|
Maybe it is better to add a warning in |
|
@iSazonov Either a warning in Start-PSPester (if it's possible to check for the sub modules there, then even better) or a note in the documentation. Just so long as submodules are more closely linked to testing due to the dependencies. |
|
@iSazonov @markekraus If we choose to add a warning to |
|
restarted macOS ci |
|
Sent up a PR for the build script warning: #5069 |
The bit about submodules in the README is easy to miss or forget if you're reading deep into the docs. It might be helpful to have a reminder here if someone is having trouble with the Pester module not being found.