ci: add a feature request issue template

Aperta Adatta ai principianti
#1,747 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, yaml
Ambito
documentation

Direzione di ricerca

Inizia da .github/ISSUE_TEMPLATE/bug-report.yml per esaminare la struttura del modulo e le opzioni per l’area, poi leggi doc/contribute.md per consultare i link esistenti alle issue. Aggiungi il modulo per la feature richiesto e il link alla guida per i contributi. How deve essere facoltativo e va evitata l’assegnazione automatica dell’etichetta feature-accepted. Il lavoro è terminato quando il modulo soddisfa i criteri di accettazione elencati e sono stati verificati il YAML e il modulo renderizzato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: ci feature-accepted

What?

Add a GitHub Issue Form at .github/ISSUE_TEMPLATE/feature-request.yml for
proposing NVX features and enhancements. Use the existing
bug-report.yml
as the structural and stylistic starting point, retaining What, Why, and
How
rather than introducing a lengthy design questionnaire.

Why?

NVX has bug-report and CPU-profile request forms, but no general feature-request
form. A dedicated form would help contributors describe the problem, desired
outcome, and practical value consistently, and give maintainers enough context
to discuss scope before implementation.

Submitting an idea should not require a completed technical design or a
commitment to implement it. Both
Microsoft MXC
and
Windows Terminal
require a feature description but leave implementation details optional.
MXC's contribution guide
also separates proposing a feature from agreeing its scope and reviewing any
needed design with maintainers, who record the shared plan with
feature-accepted.

How?

Proposed form:

  • Set the name to Feature request and the issue type to Feature.

  • Reuse the bug-report form's required Area dropdown and area choices,
    adapting its description to feature requests.

  • Keep three narrative fields:

    Field Required Guidance
    What is this feature about? Yes Describe the problem or missing capability and the desired behavior or outcome.
    Why is this feature relevant? Yes Explain the use case, who benefits, and the limitations of existing alternatives or workarounds.
    How could this feature be implemented? No Share any proposed approach, alternatives, constraints, or examples. A finished design is not required.
  • Include a short introduction asking contributors to search for duplicates,
    avoid sharing sensitive information, and use the private security-reporting
    route for vulnerabilities, following the bug-report form.

  • Explain that a problem and use case are enough to start the discussion;
    contributors should agree scope and any needed design with maintainers before
    implementation.

  • Do not apply feature-accepted automatically. Maintainers apply it after
    agreeing a request's scope and any needed design.

  • Add a feature-request link beside the bug-report link in
    the contribution guide.
    Explain that maintainers mark accepted requests feature-accepted. Leave the
    existing bug-report and CPU-profile forms and blank-issue policy unchanged.

Do not introduce a broader design-approval workflow as part of this change.

Acceptance criteria

  • The feature-request form appears in GitHub's issue chooser with the
    agreed metadata, area choices, and What / Why / How fields.
  • Area, What, and Why are required; a request can be submitted without How.
  • Submitted requests do not receive feature-accepted automatically.
  • The contribution guide links to the form and explains
    feature-accepted; existing issue forms are unchanged.
  • Validate the YAML with the repository's applicable quality checks and
    verify the rendered form, required fields, and labels on GitHub.
Lingua principale
Rust
Stelle
848
Fork
63
Merge medio
12h 24m
PR unite (30g)
612

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/nvx

Tutte le issue di microsoft/nvx

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.