ci: add a feature request issue template

Abierto Apto para principiantes
#1,747 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github, yaml

Línea de trabajo

Empieza con .github/ISSUE_TEMPLATE/bug-report.yml para revisar la estructura del formulario y las opciones de áreas, y luego lee doc/contribute.md para ver los enlaces existentes a issues. Añade el formulario de feature solicitado y el enlace a la guía de contribución. How debe ser opcional y se debe evitar el etiquetado automático con feature-accepted. El trabajo estará terminado cuando el formulario cumpla los criterios de aceptación indicados y se hayan verificado el YAML y el formulario renderizado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Rust
Estrellas
848
Forks
63
Merge medio
12 h 24 min
PR fusionados (30 d)
612

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de microsoft/nvx

Todos los issues de microsoft/nvx

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.