microsoft / microsoft/winget-cli

Strengthen contributor guidance to support Help-Wanted contributions

Open
#6,393 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Feature
Dominant language
C++
Stars
26.4k
Forks
1.8k
Avg merge
1d 11h
Merged PRs (30d)
15

Description

Overview

We are increasingly labeling small, well-scoped features as Help-Wanted (for example #1003 and #1058) to invite community contributions. To set new contributors up for success - and to keep the quality bar high - our contributor guidance needs to clearly communicate our expectations before someone starts work.

This is a tracking issue for a set of documentation and process improvements. Each sub-issue can be addressed by its own PR that closes it, moving us toward the broader goal.

Goals

  • Give new contributors clear, discoverable orientation to the project and our expectations.
  • Set explicit expectations for tests, coding conventions, and evidence that a change works.
  • Establish a guardrail so we are not opening the floodgates to low-effort AI-generated PRs, while still welcoming responsible AI-assisted contributions.
  • Reinforce the existing "to spec or not to spec" flow for Issue-Feature work.

Work items

  • Define testing requirements in CONTRIBUTING.md (sub-issue)
  • Add coding conventions guidance for contributors (sub-issue)
  • Add a policy on AI-generated / AI-assisted contributions (sub-issue)
  • Update the pull request template: evidence, tests, and AI disclosure (sub-issue)

Engineers will be looped in on the sub-issues where the team needs to define or ratify specifics (e.g., the exact testing bar, the coding conventions themselves, and the wording of the AI policy).

Follow-up (dependent on the above)

Once the guidance is in good shape, add a policy bot rule (.github/policies/) so that when the Help-Wanted label is applied to an issue, a concise orientation comment is posted linking contributors to the updated guidance (spec-or-not, tests required, evidence expected, AI policy). Tracked separately once these land.

(Created with GitHub Copilot assistance.)

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 CONTRIBUTING.md and the pull request template, then review the listed work items and the existing “to spec or not to spec” flow. The issue requires defining or ratifying testing, coding-convention, AI-assistance, evidence, and disclosure guidance before updating those documents. Done means the guidance and template changes are agreed and complete; the later policy-bot rule is explicitly tracked separately.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.