Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stdlib-candidate Reset #986

Merged
merged 2 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions stdlib-candidate-old/README.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions stdlib-candidate-old/nupm.nuon
Original file line number Diff line number Diff line change
@@ -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"
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
38 changes: 37 additions & 1 deletion stdlib-candidate/README.md
Original file line number Diff line number Diff line change
@@ -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


2 changes: 1 addition & 1 deletion stdlib-candidate/nupm.nuon
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Loading