From 720813339f3b1de6f7f73fd50409ff84b72bac26 Mon Sep 17 00:00:00 2001 From: Douglas <32344964+NotTheDr01ds@users.noreply.github.com> Date: Sun, 9 Feb 2025 11:21:56 -0500 Subject: [PATCH] Add `std-rfc` README (#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. --- crates/nu-std/std-rfc/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 crates/nu-std/std-rfc/README.md diff --git a/crates/nu-std/std-rfc/README.md b/crates/nu-std/std-rfc/README.md new file mode 100644 index 0000000000..75e20159ba --- /dev/null +++ b/crates/nu-std/std-rfc/README.md @@ -0,0 +1,30 @@ +# `std-rfc` + +## Overview and Requirements + +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: + +* Be general purpose features that will be useful to a number of users +* Include doc comments for definitions and parameters that can be used with `help ` +* Include tests +* Since doc comments are fairly limited, additional documentation can be included + in a GitHub discussion. This documentation can then be moved to the main website when the feature + is promoted to `std`. See [this example](https://github.com/nushell/nushell/discussions/14935#discussion-7882769) for some `table` helpers. + +## Showcase and Discussion + +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: + +* Ideation before a PR is submitted +* Raise awareness of the feature +* Short-term questions and discussion + +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. + +## Promotion Evaluation + +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: + +* Promoted to `std` +* Removed from `std-rfc` +* Or changes may be requested and then reevaluated later