dsccommunity / dsccommunity/SqlServerDsc
CONTRIBUTING.md: Add a section about SQLPS stubs, how they are used in tests
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
Details of the scenario you try and problem that is occurring:
There is no mention in the specific contribution guidelines about the SQLPS stubs that shuld be used in tests when mockin SQLPS cmdlets. This enables the tests to run on any client without the SQLPS module installed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open CONTRIBUTING.md and review the existing contribution guidance and references to tests. Add a section explaining that SQLPS stubs should be used when mocking SQLPS cmdlets, and that this keeps tests runnable on clients without the SQLPS module installed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100