microsoft / microsoft/winget-cli
Localizing help and making it updatable
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 26.4k
- Forks
- 1.8k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 15
Description
Localising help means translating the help text to non-EN-US languages and including those translations in the module. PowerShell does a great job handling this, but you must design it into the module.
As it turns out, the PowerShell team have some great guidance for this: https://learn.microsoft.com/en-us/powershell/scripting/developer/help/writing-help-for-windows-powershell-modules?view=powershell-7.3
Also, it looks like the module does not support updatable help either. You could consider fixing this.
Originally posted by @doctordns in https://github.com/microsoft/winget-cli/discussions/3182#discussioncomment-5779934
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 with the PowerShell module's help implementation and the linked Microsoft guidance on writing help for modules. Determine the scope for translated help and updatable help, then verify that the module supports both requirements and that the help content can be maintained separately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation, localization
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100