Reset stdlib-candidate

nushell · Dec 4, 2024 · 99f6da6 · 99f6da6
1 parent 4784669
commit 99f6da6
Show file tree

Hide file tree

Showing 38 changed files with 50 additions and 2 deletions.
diff --git a/stdlib-candidate-old/README.md b/stdlib-candidate-old/README.md
@@ -0,0 +1,4 @@
+# std-lib candidate
+
+This folder is where we can add scripts that might want to be in std-lib at some point. It can serve both as a holding place for scripts that are waiting on nushell changes, as well as a place to develop and discuss such scripts.
+
diff --git a/stdlib-candidate-old/nupm.nuon b/stdlib-candidate-old/nupm.nuon
@@ -0,0 +1,8 @@
+{
+    name: "std-rfc"
+    description: "Official candidates for Nushell standard library"
+    documentation: "https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/std-rfc/README.md"
+    license: "https://github.com/nushell/nu_scripts/blob/main/LICENSE"
+    version: 0.3.0
+    type: "module"
+}
diff --git a/stdlib-candidate/std-rfc/bench.nu → stdlib-candidate-old/std-rfc/bench.nu b/stdlib-candidate/std-rfc/bench.nu → stdlib-candidate-old/std-rfc/bench.nu
diff --git a/stdlib-candidate/std-rfc/bulk-rename.nu → stdlib-candidate-old/std-rfc/bulk-rename.nu b/stdlib-candidate/std-rfc/bulk-rename.nu → stdlib-candidate-old/std-rfc/bulk-rename.nu
diff --git a/stdlib-candidate/std-rfc/conversions/into.nu → ...candidate-old/std-rfc/conversions/into.nu b/stdlib-candidate/std-rfc/conversions/into.nu → ...candidate-old/std-rfc/conversions/into.nu
diff --git a/stdlib-candidate/std-rfc/conversions/mod.nu → ...-candidate-old/std-rfc/conversions/mod.nu b/stdlib-candidate/std-rfc/conversions/mod.nu → ...-candidate-old/std-rfc/conversions/mod.nu
diff --git a/stdlib-candidate/std-rfc/flatter.nu → stdlib-candidate-old/std-rfc/flatter.nu b/stdlib-candidate/std-rfc/flatter.nu → stdlib-candidate-old/std-rfc/flatter.nu
diff --git a/...idate/std-rfc/get-latest-release-linux.nu → ...e-old/std-rfc/get-latest-release-linux.nu b/...idate/std-rfc/get-latest-release-linux.nu → ...e-old/std-rfc/get-latest-release-linux.nu
diff --git a/stdlib-candidate/std-rfc/math/mod.nu → stdlib-candidate-old/std-rfc/math/mod.nu b/stdlib-candidate/std-rfc/math/mod.nu → stdlib-candidate-old/std-rfc/math/mod.nu
diff --git a/stdlib-candidate/std-rfc/mod.nu → stdlib-candidate-old/std-rfc/mod.nu b/stdlib-candidate/std-rfc/mod.nu → stdlib-candidate-old/std-rfc/mod.nu
diff --git a/stdlib-candidate/std-rfc/nu_style.nu → stdlib-candidate-old/std-rfc/nu_style.nu b/stdlib-candidate/std-rfc/nu_style.nu → stdlib-candidate-old/std-rfc/nu_style.nu
diff --git a/stdlib-candidate/std-rfc/print.nu → stdlib-candidate-old/std-rfc/print.nu b/stdlib-candidate/std-rfc/print.nu → stdlib-candidate-old/std-rfc/print.nu
diff --git a/stdlib-candidate/std-rfc/record/README.md → ...ib-candidate-old/std-rfc/record/README.md b/stdlib-candidate/std-rfc/record/README.md → ...ib-candidate-old/std-rfc/record/README.md
diff --git a/stdlib-candidate/std-rfc/record/mod.nu → stdlib-candidate-old/std-rfc/record/mod.nu b/stdlib-candidate/std-rfc/record/mod.nu → stdlib-candidate-old/std-rfc/record/mod.nu
diff --git a/stdlib-candidate/std-rfc/script-parsing.nu → ...b-candidate-old/std-rfc/script-parsing.nu b/stdlib-candidate/std-rfc/script-parsing.nu → ...b-candidate-old/std-rfc/script-parsing.nu
diff --git a/stdlib-candidate/std-rfc/set-env.nu → stdlib-candidate-old/std-rfc/set-env.nu b/stdlib-candidate/std-rfc/set-env.nu → stdlib-candidate-old/std-rfc/set-env.nu
diff --git a/stdlib-candidate/std-rfc/str/dedent/mod.nu → ...b-candidate-old/std-rfc/str/dedent/mod.nu b/stdlib-candidate/std-rfc/str/dedent/mod.nu → ...b-candidate-old/std-rfc/str/dedent/mod.nu
diff --git a/stdlib-candidate/std-rfc/str/mod.nu → stdlib-candidate-old/std-rfc/str/mod.nu b/stdlib-candidate/std-rfc/str/mod.nu → stdlib-candidate-old/std-rfc/str/mod.nu
diff --git a/stdlib-candidate/std-rfc/str/xpend.nu → stdlib-candidate-old/std-rfc/str/xpend.nu b/stdlib-candidate/std-rfc/str/xpend.nu → stdlib-candidate-old/std-rfc/str/xpend.nu
diff --git a/...b-candidate/std-rfc/tables/col-indices.nu → ...ndidate-old/std-rfc/tables/col-indices.nu b/...b-candidate/std-rfc/tables/col-indices.nu → ...ndidate-old/std-rfc/tables/col-indices.nu
diff --git a/stdlib-candidate/std-rfc/tables/mod.nu → stdlib-candidate-old/std-rfc/tables/mod.nu b/stdlib-candidate/std-rfc/tables/mod.nu → stdlib-candidate-old/std-rfc/tables/mod.nu
diff --git a/...te/std-rfc/tables/reject-column-ranges.nu → ...ld/std-rfc/tables/reject-column-ranges.nu b/...te/std-rfc/tables/reject-column-ranges.nu → ...ld/std-rfc/tables/reject-column-ranges.nu
diff --git a/...candidate/std-rfc/tables/reject-ranges.nu → ...idate-old/std-rfc/tables/reject-ranges.nu b/...candidate/std-rfc/tables/reject-ranges.nu → ...idate-old/std-rfc/tables/reject-ranges.nu
diff --git a/...b-candidate/std-rfc/tables/row-indices.nu → ...ndidate-old/std-rfc/tables/row-indices.nu b/...b-candidate/std-rfc/tables/row-indices.nu → ...ndidate-old/std-rfc/tables/row-indices.nu
diff --git a/...te/std-rfc/tables/select-column-ranges.nu → ...ld/std-rfc/tables/select-column-ranges.nu b/...te/std-rfc/tables/select-column-ranges.nu → ...ld/std-rfc/tables/select-column-ranges.nu
diff --git a/...candidate/std-rfc/tables/select-ranges.nu → ...idate-old/std-rfc/tables/select-ranges.nu b/...candidate/std-rfc/tables/select-ranges.nu → ...idate-old/std-rfc/tables/select-ranges.nu
diff --git a/stdlib-candidate/tests/bench.nu → stdlib-candidate-old/tests/bench.nu b/stdlib-candidate/tests/bench.nu → stdlib-candidate-old/tests/bench.nu
diff --git a/stdlib-candidate/tests/bulk-rename.nu → stdlib-candidate-old/tests/bulk-rename.nu b/stdlib-candidate/tests/bulk-rename.nu → stdlib-candidate-old/tests/bulk-rename.nu
diff --git a/stdlib-candidate/tests/conversions.nu → stdlib-candidate-old/tests/conversions.nu b/stdlib-candidate/tests/conversions.nu → stdlib-candidate-old/tests/conversions.nu
diff --git a/stdlib-candidate/tests/math.nu → stdlib-candidate-old/tests/math.nu b/stdlib-candidate/tests/math.nu → stdlib-candidate-old/tests/math.nu
diff --git a/stdlib-candidate/tests/mod.nu → stdlib-candidate-old/tests/mod.nu b/stdlib-candidate/tests/mod.nu → stdlib-candidate-old/tests/mod.nu
diff --git a/stdlib-candidate/tests/record.nu → stdlib-candidate-old/tests/record.nu b/stdlib-candidate/tests/record.nu → stdlib-candidate-old/tests/record.nu
diff --git a/stdlib-candidate/tests/script-parsing.nu → stdlib-candidate-old/tests/script-parsing.nu b/stdlib-candidate/tests/script-parsing.nu → stdlib-candidate-old/tests/script-parsing.nu
diff --git a/stdlib-candidate/tests/str_dedent.nu → stdlib-candidate-old/tests/str_dedent.nu b/stdlib-candidate/tests/str_dedent.nu → stdlib-candidate-old/tests/str_dedent.nu
diff --git a/stdlib-candidate/tests/str_xpend.nu → stdlib-candidate-old/tests/str_xpend.nu b/stdlib-candidate/tests/str_xpend.nu → stdlib-candidate-old/tests/str_xpend.nu
diff --git a/stdlib-candidate/tests/tables.nu → stdlib-candidate-old/tests/tables.nu b/stdlib-candidate/tests/tables.nu → stdlib-candidate-old/tests/tables.nu
diff --git a/stdlib-candidate/README.md b/stdlib-candidate/README.md
@@ -1,4 +1,40 @@
 # std-lib candidate
 
-This folder is where we can add scripts that might want to be in std-lib at some point. It can serve both as a holding place for scripts that are waiting on nushell changes, as well as a place to develop and discuss such scripts.
+## 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
+* Have broad appeal to other users
+* Include doc comments for definitions and parameters that can be used with `help <command>`
+* Include tests
+
+The last two (doc and tests) do not need to be in place at the time of the initial inclusion in `stdlib-candidate`, but are, of course, required in order to promote to `std`.
+
+## 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 PR
+* Short-term questions and discussion
+
+Note: The Drawing Board is not just for stdlib-candidate. Please tag your topic with `std-library` if it is about a Standard Library idea.
+
+## Promotion Evaluation
+
+In general, PRs will be evaluated after they have been trialed for a sufficient period, expected to be around 2 months. After that period, the feature may be:
+
+* Promoted to `std`
+* Removed from `stdlib-candidate`
+* Or changes may be requested and then reevaluated later
+
+## NUPM Note
+
+When submitting a PR, please bump the module's `nupm.nuon`.
+
+# Previous Repo
+
+Note: As of December 2024, the candidate module has been "reset" to start fresh. The previous version has been moved to https://github.com/nushell/nu_scripts/tree/main/stdlib-candidate/old
+
 
diff --git a/stdlib-candidate/nupm.nuon b/stdlib-candidate/nupm.nuon
@@ -3,6 +3,6 @@
     description: "Official candidates for Nushell standard library"
     documentation: "https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/std-rfc/README.md"
     license: "https://github.com/nushell/nu_scripts/blob/main/LICENSE"
-    version: 0.3.0
+    version: 0.4.0
     type: "module"
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# std-lib candidate

		This folder is where we can add scripts that might want to be in std-lib at some point. It can serve both as a holding place for scripts that are waiting on nushell changes, as well as a place to develop and discuss such scripts.