PowerShell / PowerShell/PowerShell-RFC

RFC Proposal Template enhancement suggestion

未关闭
#211 0 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
PowerShell
星标
467
派生
140
平均合并
9 分钟
30 天内合并 PR
1

描述

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?

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

在 PowerShell-RFC 仓库中找到现有的 RFC 模板,并将其与 issue 中提议的 Markdown 结构进行比较。添加已达成一致的采用和实现支持部分,然后验证模板能够正确渲染,并保留现有的元数据和指导内容。

由索引模型根据 Issue 内容生成。

评估

技术栈
powershell
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。