Skip to content

Commit 17db4a7

Browse files
committed
update template fixing spelling error and adding section for user experience
1 parent 249e8d8 commit 17db4a7

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

RFC0000-RFC-Process.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Feedback: https://github.com/PowerShell/PowerShell-Language-RFC/issues/5
1010
# PowerShell RFC Process and Guidelines
1111

1212
A PowerShell RFC (Request for Comments) is a publication to propose design changes and improvements to PowerShell.
13-
This provides the community an opportunity to provide feedback before code is written where it becomes harder to change at the risk of
13+
This provides the community an opportunity to provide feedback before code is written where it becomes harder to change at the risk of
1414
compatibility.
1515
The complete list of RFCs are available at https://github.com/powershell/powershell-rfc
1616

@@ -33,7 +33,7 @@ This process was adapted from the Chef RFC process as well as from the DMTF.org
3333

3434
RFC documents shall follow the following template:
3535

36-
```markdown
36+
````markdown
3737
---
3838
RFC: RFC<four digit unique incrementing number assigned by Committee, this shall be left blank by the author>
3939
Author: <First Last>
@@ -55,18 +55,31 @@ Description and rationale.
5555
I can <<functionality>>,
5656
so that <<benefit>>.
5757

58+
## User Experience
59+
60+
Example of user experience with example code/script.
61+
Include example of input and output.
62+
63+
```powershell
64+
Get-Example
65+
```
66+
67+
```output
68+
Hello World
69+
```
70+
5871
## Specification
5972

6073
## Alternate Proposals and Considerations
6174

62-
```
75+
````
6376

6477
## RFC Workflow
6578

6679
RFCs may go through the following stages:
6780

6881
### Draft
69-
82+
7083
This is the initial draft of an RFC posted for comments and considered a work-in-progress.
7184

7285
* New proposed drafts should be submitted as a Pull Request from the Author's fork into the `Draft-Accepted` folder.
@@ -75,15 +88,15 @@ This is the initial draft of an RFC posted for comments and considered a work-in
7588
Typically, one or two months is allowed for comments, though this may be extended if a submission is particularly contentious or hasn't received enough feedback for the Committee to feel comfortable making a decision.
7689
* When the Committee closes the comment period, the Author should update the RFC and Pull Request with a new commit to address the comments.
7790
* The Committee shall vote to merge or reject the RFC.
78-
Note: the Comittee may be slower to respond to RFCs where the Author has indicated that they do not plan to implement the RFC.
91+
Note: the Committee may be slower to respond to RFCs where the Author has indicated that they do not plan to implement the RFC.
7992

8093
### Draft-Accepted
8194

8295
The PowerShell Committee has reviewed the RFC and comments, and has voted to accept the RFC as a Draft.
8396

8497
* New comments are not being sought.
8598
* No one has begun implementing the RFC, and there are no current plans to implement the RFC.
86-
In this case, the Comittee will create `up-for-grabs` Issues in the [PowerShell](https://github.com/PowerShell/PowerShell) repository.
99+
In this case, the Committee will create `up-for-grabs` Issues in the [PowerShell](https://github.com/PowerShell/PowerShell) repository.
87100

88101
### Experimental
89102

@@ -93,7 +106,7 @@ RFCs in the `Experimental` stage have been accepted by the Committee, and code i
93106

94107
Feedback from the experimental implementation and RFC have been reviewed.
95108

96-
Because this working prototype already exists in preview builds available on GitHub, the community provide feedback on the implementation as issues in the [PowerShell/PowerShell repository](https://github.com/powershell/powershell)
109+
Because this working prototype already exists in preview builds available on GitHub, the community provide feedback on the implementation as issues in the [PowerShell/PowerShell repository](https://github.com/powershell/powershell)
97110

98111
As the engineering team or code contributor works towards a final implementation, they should submit pull requests to PowerShell-RFC in order to keep the RFC in sync with the implementation.
99112
These pull requests shall be reviewed and accepted by the Committee, but a formal vote is not necessary.
@@ -114,6 +127,7 @@ Any proposed changes should be made through a new RFC or via an Issue in the [Po
114127
New RFCs should reference old RFCs where applicable.
115128

116129
## History
130+
117131
v1.1 - 5-20-2016 - Updated to enable RFCs for design changes that don't require code changes.
118132
Added Draft-Accepted state and Version header property.
119133

0 commit comments

Comments
 (0)