[FEATURE] Improve documentation for working with change files only
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C#
- Stars
- 474
- Forks
- 65
- Avg merge
- 22h 25m
- Merged PRs (30d)
- 26
Description
Your suggestion
Provide a more detailed walkthrough for basic and advanced cases working with change files only. i.e. What happens and how to configure expanding the change set with interlinked files.
See: https://github.com/microsoft/PSRule/issues/2771#issuecomment-2662967448
Alternatives
n/a
Additional context
See #2771
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 by reading issue #2771 and its referenced comment, then locate the existing documentation for working with change files only. Expand it with basic and advanced walkthroughs, including how configuration handles interlinked files; the work is done when those cases and change-set expansion are explained clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100