microsoft / microsoft/winget-pkgs
[New Feature]: Trim certain ShortDescription values, so "[Package name]" won't have the ShortDescription "[Package name] is a/an/the (…)"
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 11.1k
- Forks
- 9.7k
- Avg merge
- 1h 32m
- Merged PRs (30d)
- 616
Description
Description of the new feature/enhancement
This seems to affect a low 4-digit number of packages.
Essentially, to take a hypothetical scenario with example names:
- The package has
PackageName: Aeiou - The package also has
ShortDescription: Aeiou is a (...)
Ideally, such circumstances should be trimmed to avoid redundancies, so it would become ShortDescription: A (...)
Proposed technical implementation details (optional)
Get a bot to run this case-insensitive RegEx on all packages:
^(PackageName: (.*)\n(.*\n){0,}ShortDescription:) \2 is a([n ].*)$ → \1 A\4
If it goes well, get a bot to run this case-insensitive RegEx as well:
^(PackageName: (.*)\n(.*\n){0,}ShortDescription:) \2 is the (.*)$ → \1 The \4
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
No files, tests, or entry points are named. Start by reviewing the proposed case-insensitive regular expressions and how package manifests are processed at repository scale; done means matching ShortDescription values are trimmed without changing unrelated package metadata, including both “is a/an” and “is the” cases.
Written by the indexing model from the issue text.
Assessment
- Domain
- content
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100