PowerShell / PowerShell/PowerShell-RFC

RFC Proposal Template enhancement suggestion

Offen
#211 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
PowerShell
Sterne
467
Forks
140
Ø Merge
9 Min.
Gemergte PRs (30 T.)
1

Beschreibung

As use of the RFC Process grows and proposals to enhance and expand language features increases, I feel there is a need to make a minor amendment to the RFC Template to encourage RFC authors to think about the wider items outside of the RFC proposal including what others can focus on post RFC implementation that will help drive the successful education, use and adoption of these new features.

Therefore I propose that we make an amendment to the RFC template to include an additional small section where the author can outline what they think will aid the successful adoption of these new features within a newer version of the language (v7 / v8 / v9 etc) so that for those, like myself, that blog/present/stream etc can look for suggestions in areas which they can focus on for creating new content that can aid the adoption of these features. This would also help in identifying areas in the supporting tooling, for example PSScriptAnalyzer/PES, to potentially add new features that further help aid adoption. going forward.

I would also suggest to add an additional area where the RFC Author could showcase that with some support & guidance they would intent to implement as well as a section to detail any support they may require to help them be able to implement this.

This could look like the below

---
RFC: RFC<four digit unique incrementing number assigned by Committee, this shall be left blank by the author>
Author: <First Last>
Status: <Draft | Experimental | Accepted | Rejected | Withdrawn | Final>
SupercededBy: <link to another RFC>
Version: <Major>.<Minor>
Area: <Area within the PowerShell language>
Comments Due: <Date for submitting comments to current draft (minimum 1 month)>
Plan to implement: <Yes | No>
Require Support to implement:  <Yes | No>
---

# Title

Description and rationale.

## Motivation

    As a <<user_profile>>,
    I can <<functionality>>,
    so that <<benefit>>.

## User Experience

Example of user experience with example code/script.
Include example of input and output.

## Specification

## Alternate Proposals and Considerations

## Supporting Adoption 

## Support required to Implement

I'll submit a PR for this change if this seems ok to others?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Suchen Sie die vorhandene RFC-Vorlage im PowerShell-RFC-Repository und vergleichen Sie sie mit der vorgeschlagenen Markdown-Struktur im Issue. Fügen Sie die vereinbarten Abschnitte zur Übernahme und zur Implementierungsunterstützung hinzu und überprüfen Sie anschließend, dass die Vorlage korrekt gerendert wird und ihre vorhandenen Metadaten und Leitlinien beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
powershell
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.