Skip to content

Update testing-guidelines.md to remind users about submodules#5061

Merged
TravisEz13 merged 1 commit intoPowerShell:masterfrom
djweber:patch-1
Oct 10, 2017
Merged

Update testing-guidelines.md to remind users about submodules#5061
TravisEz13 merged 1 commit intoPowerShell:masterfrom
djweber:patch-1

Conversation

@djweber
Copy link
Copy Markdown

@djweber djweber commented Oct 9, 2017

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.

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.
@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 9, 2017

@markekraus
Copy link
Copy Markdown
Contributor

@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.

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 9, 2017

I think "dry" principle is good for docs too. We plan remove submodules and already have removed some.

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 9, 2017

Maybe it is better to add a warning in Start-PSPester.

@markekraus
Copy link
Copy Markdown
Contributor

@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.

@djweber
Copy link
Copy Markdown
Author

djweber commented Oct 9, 2017

@iSazonov @markekraus If we choose to add a warning to Start-PSPester, I can help with that.

@TravisEz13
Copy link
Copy Markdown
Member

restarted macOS ci

@djweber
Copy link
Copy Markdown
Author

djweber commented Oct 9, 2017

Sent up a PR for the build script warning: #5069

@TravisEz13 TravisEz13 merged commit a1b7f8b into PowerShell:master Oct 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants