dsccommunity / dsccommunity/SqlServerDsc
CONTRIBUTING.md: Add a section explain the format of the Examples
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
The examples need to be in a certain format for the tests to be able to verify them. This format need to be documented.
- Folder structure
- Format of the Congfiguration function.
- Make sure all the variants of parameters with qualifier type Key are tested in the same configuration (to be able to test for breaking changes).
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
Start in CONTRIBUTING.md and compare the documentation with the example at Examples/Resources/xSQLServerDatabaseRecoveryModel/1-SetDatabaseRecoveryModel.ps1. Add a section covering the folder structure, Configuration function format, and testing all parameter variants with qualifier type Key in one configuration. Done means contributors can use the section to format examples consistently for the tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100