1
Fork 0
mirror of https://github.com/RGBCube/nu_scripts synced 2025-08-01 06:37:46 +00:00

Stdlib-candidate Reset (#986)

On today's call, we decided to reset stdlib-candidate and start fresh
(and try to manage it more effectively going forward).

This PR is that reset, along with an updated README for the new module.

The main thing that needs reviewing here is the
[README](https://github.com/nushell/nu_scripts/pull/986/files#diff-680b95f9d9e2e9c06ee31ff6835e5d29ba11703ef7252bd42ecafa433767e0c6).
This commit is contained in:
Douglas 2024-12-05 12:45:59 -05:00 committed by GitHub
parent c2d10f17af
commit 6c9f974df6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
38 changed files with 49 additions and 2 deletions

View file

@ -0,0 +1,3 @@
# std-lib candidate
This is the deprecated `stdlib-candidate` module. Please see the [new version](https://github.com/nushell/nu_scripts/tree/main/stdlib-candidate). If you have a submission here, you can move it to the new repo. Please refer to the [README](https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/README.md) there for the process.

View file

@ -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"
}

View file

@ -1,4 +1,40 @@
# std-lib candidate # 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

View file

@ -3,6 +3,6 @@
description: "Official candidates for Nushell standard library" description: "Official candidates for Nushell standard library"
documentation: "https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/std-rfc/README.md" 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" license: "https://github.com/nushell/nu_scripts/blob/main/LICENSE"
version: 0.3.0 version: 0.4.0
type: "module" type: "module"
} }