1
Fork 0
mirror of https://github.com/RGBCube/nu_scripts synced 2025-07-30 13:47:46 +00:00

Deprecate the nu_scripts version of stdlib-candidate (#1042)

Deprecates the existing `stdlib-candidate` directories in `nu_scripts`
since `std-rfc` has now transitioned to the main repo. Updates readme
and renamed directories.
This commit is contained in:
Douglas 2025-02-09 15:34:40 -05:00 committed by GitHub
parent a31f8490fb
commit 5869e0b529
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
53 changed files with 18 additions and 40 deletions

View file

@ -0,0 +1,18 @@
# std-lib candidate is deprecated
Going forward, `std-rfc` will be included in the main Nushell release,
just like `std` is. This will allow users to more easily try-out its potential
new commands and features.
Please contribute new `std` proposals to the main Nushell repository.
See that [README](https://github.com/nushell/nushell/blob/main/crates/nu-std/std-rfc/README.md)
for more information on how to contribute.
## Removal
This directory will be preserved for some period during deprecation, but no new
contributions are expected to be accepted. Any remaining items from
the older (pre-December 2024) `stdlib-candidate-old` should be identified for transition
to `std-rfc`, since at some point we expect to delete this directory.

View file

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