From f378c72f6f4fdd1656fd5eb11802ac2a31cac897 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikkel=20Roald-Arb=C3=B8l?= <25629697+roaldarbol@users.noreply.github.com> Date: Thu, 6 Jun 2024 01:53:34 +0100 Subject: [PATCH] Create `CITATION.cff` (#12983) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Description This PR creates a `CITATION.cff` file. # User-Facing Changes Users will now be able to properly cite `nushell` when used e.g. in scientific work. The `CITATION.cff` file also enables users to get the citation withe the Github integration, see [documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). More information about the `.cff` standard [here](https://citation-file-format.github.io/). # After Submitting Do you want it documented in the docs somewhere? If so, where exactly? Happy to make a PR there. One feature that could well be implemented later on is automatic updates to the CITATION file with a Github Action (this is outside of my comfort zone, so I'll leave that for a separate PR should anyone want to implement it). Ideally, the `CITATION.cff` file points to the latest release , and could do so with the following fields: ``` commit: version: date-released: ``` --------- Co-authored-by: Mikkel Roald-Arbøl Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: NotTheDr01ds <32344964+NotTheDr01ds@users.noreply.github.com> --- CITATION.cff | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..25731e87b2 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,26 @@ +cff-version: 1.2.0 +title: 'Nushell' +message: >- + If you use this software and wish to cite it, + you can use the metadata from this file. +type: software +authors: + - name: "The Nushell Project Team" +identifiers: + - type: url + value: 'https://github.com/nushell/nushell' + description: Repository +repository-code: 'https://github.com/nushell/nushell' +url: 'https://www.nushell.sh/' +abstract: >- + The goal of the Nushell project is to take the Unix + philosophy of shells, where pipes connect simple commands + together, and bring it to the modern style of development. + Thus, rather than being either a shell, or a programming + language, Nushell connects both by bringing a rich + programming language and a full-featured shell together + into one package. +keywords: + - nushell + - shell +license: MIT