microsoft / microsoft/winget-pkgs

Enforce best practice for package tags in manifests

Open
#27,577 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Validation-Pipeline Issue-Feature
Dominant language
No language data
Stars
11.1k
Forks
9.7k
Avg merge
1h 32m
Merged PRs (30d)
376

Description

Description of the new feature/enhancement

Enforce the defined tag best practice in manifest files defined at https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.0.0/defaultLocale.md#tags, to wit, "present these terms in all lower case with hyphens rather than spaces."

Proposed technical implementation details (optional)

This would be a two-part job, and each part can be implemented independently:

  • Update the CI validation scripts run over pull requests to reject PRs that use tags with upper-case characters and spaces.
  • Write a utility script to find and replace existing tags that use spaces or upper-case characters with hyphens and lower-case characters.

I've not exhaustively checked the existing tags; it might be that we want some of them to be in upper case (perhaps proper nouns?). I could also believe this is inappropriate and/or confusing in some locales; I'm fairly confident it'd be safe for all en_* locales – so the vast majority of tags – but I could believe there are other locales where using hyphens instead of spaces and/or using exclusively lower-case characters would change meanings in a fundamental way.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked defaultLocale.md tag guidance, then locate the CI validation scripts that run over pull requests. Done means validation rejects tags containing uppercase characters or spaces, and a separate utility can find and replace existing nonconforming tags while accounting for locale-specific concerns.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.