dsccommunity / dsccommunity/SqlServerDsc
CONTRIBUTING.md: Add a section to explain the format for the resource documentation in the README.md
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
Add a section to the specific contribution guidelines describing how to document resources.
In markdown:
* **[Type] ParameterName** (Read/Write/Required/Key): Description. Defaults to "default value" (if applicable). { *DefaultOption (if applicable)* | Option2 | Option3 }.
Result:
- [Type] ParameterName (Read/Write/Required/Key): Description. Defaults to "default value" (if applicable). { DefaultOption (if applicable) | Option2 | Option3 }.
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 locate the specific contribution guidelines for resource documentation. Add the requested Markdown format and its example, then check the README.md resource documentation to ensure the guidance matches the existing presentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100