Skip to content

Add language to make providing examples mandatory #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2019

Conversation

JamesWTruher
Copy link
Contributor

No description provided.

@@ -1,5 +1,9 @@
<!--

All new RFCs must:

* have examples of the proposed behavior, preferably in the form of a script (or scripts) which shows the proposed behavior.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pester form is good too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure - a pester script is certainly a valid script

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, but if we explicitly encourage Pester (doesn't necessarily have to be entirely mandatory) then we have some tests to work with right from the beginning as either the PS team or community members get to work on implementing the proposal. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am somewhat worried about only pester tests. Pester tests don't generally test formatting, which I believe is an important aspect of new behaviors. It's important to see the results of a new cmdlet. To date, the number of examples in the RFCs has been woefully low (hardly any), and it makes judging new behavior extremely difficult.

Co-Authored-By: Steve Lee <slee@microsoft.com>
@SteveL-MSFT SteveL-MSFT merged commit 911ce01 into PowerShell:master May 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants