Skip to content

Commit 7208133

Browse files
authored
Add std-rfc README (nushell#15066)
Copied the old README from `nu_scripts/stdlib-candidate/std-rfc` over to `nu-std/std-rfc` and updated it with the latest info.
1 parent 5b4dd77 commit 7208133

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

crates/nu-std/std-rfc/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# `std-rfc`
2+
3+
## Overview and Requirements
4+
5+
This module includes potential candidate commands (and other definitions) for inclusion in the Standard Library (`std`) that is built in to Nushell. As a general guideline, candidates should:
6+
7+
* Be general purpose features that will be useful to a number of users
8+
* Include doc comments for definitions and parameters that can be used with `help <command>`
9+
* Include tests
10+
* Since doc comments are fairly limited, additional documentation can be included
11+
in a GitHub discussion. This documentation can then be moved to the main website when the feature
12+
is promoted to `std`. See [this example](https://github.com/nushell/nushell/discussions/14935#discussion-7882769) for some `table` helpers.
13+
14+
## Showcase and Discussion
15+
16+
While primary feedback should take place in the PR, we have also established a [Drawing Board Discord Showcase](https://discord.gg/C3eMKV58MQ) which can be used for several purposes:
17+
18+
* Ideation before a PR is submitted
19+
* Raise awareness of the feature
20+
* Short-term questions and discussion
21+
22+
Note: The Drawing Board is not just for `std-rfc`. Please tag your topic with `std-library` if it is about a Standard Library idea.
23+
24+
## Promotion Evaluation
25+
26+
In general, new `std-rfc` features will be evaluated after they have been trialed for a sufficient period, which may vary depending on the feature. After that period, the feature may be:
27+
28+
* Promoted to `std`
29+
* Removed from `std-rfc`
30+
* Or changes may be requested and then reevaluated later

0 commit comments

Comments
 (0)