From c6d636531d78ea615d7631c236ac1fe0628e0cb2 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:28:05 -0700 Subject: [PATCH 01/13] Fix Citation File Template rendering and update authors --- .../contributions/code-of-conduct/README.md | 50 +++++++--- .../governance/code-of-conduct/CITATION.cff | 98 +++++-------------- 2 files changed, 60 insertions(+), 88 deletions(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 46d30973..ee5b4926 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -25,15 +25,15 @@ ## Quick Start -**[⬇️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) +**[✓️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) Access the standard Contributor Covenant template for a robust Code of Conduct policy to use in your project. -**[⬇️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** +**[✓️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[⬇️ CITATION.cff Template]([#citation-file-template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff))** +**[✓️ CITATION.cff Template](#citation-file-template)** Add a citation file to make your project properly citable in academic and research contexts. @@ -54,12 +54,28 @@ Add a citation file to make your project properly citable in academic and resear --- -## Additional Guidance on Scientific Collaboration +## Code of Collaboration -In addition to the standard Contributor Covenant, this project includes a supplementary document: [`CODE_OF_COLLAB.md`](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md), which outlines expectations specific to scientific research collaboration. +In addition to the standard Contributor Covenant, you should consider adding a supplementary document: `CODE_OF_COLLAB.md`, which outlines expectations specific to scientific research collaboration. -- Use the [**Contributor Covenant**](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) for general behavior and inclusive participation in open-source settings. -- For scientific research collaboration, refer to [**CODE_OF_COLLAB.md**]([./CODE_OF_COLLAB.md](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)) to understand our **collaboration expectations** in the context of research, publication, and funding goals. +### Step-by-Step Guide for Adding Code of Collaboration: + +1. **Creating the Document**: + - Create a `CODE_OF_COLLAB.md` file in the root of your repository. + - Use the [template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md) as a starting point. + - Customize the content to reflect your project's specific needs and context. + +2. **Key Components to Include**: + - Research integrity principles + - Collaborative expectations + - Authorship and publication guidelines + - Open science commitments + +3. **Integration with Your Project**: + - Reference the `CODE_OF_COLLAB.md` in your `README.md` + - Link to it from your `CODE_OF_CONDUCT.md` as a supplementary document + +For scientific research collaboration, refer to [**CODE_OF_COLLAB.md**](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md) to understand our **collaboration expectations** in the context of research, publication, and funding goals. --- @@ -69,20 +85,21 @@ Academic citation is a crucial aspect of scientific and research software projec ### Creating a CITATION.cff File -We recommend adding a `CITATION.cff` file to the root of your repository. This file follows the [Citation File Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff) specification and provides structured metadata that can be automatically processed by citation management tools. +We recommend adding a `CITATION.cff` file to the root of your repository. This file follows the [Citation File Format](https://citation-file-format.github.io/) specification and provides structured metadata that can be automatically processed by citation management tools. 1. **Setting Up the Citation File**: - Create a `CITATION.cff` file in the root of your repository. - - Use the [template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff), replacing placeholder values with your project details. + - Use the [template](#citation-file-template), replacing placeholder values with your project details. - Include all significant contributors as authors. 2. **Integrate with Your Project**: - Add a citation section to your `README.md` with instructions on how to cite your work. - Consider connecting your repository to [Zenodo](https://zenodo.org/) to obtain a DOI. -### [Citation File Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff) +### Citation File Template + ```yaml # CITATION.cff - This file provides citation information for your project cff-version: 1.2.0 @@ -97,6 +114,14 @@ authors: given-names: "First Name" affiliation: "Your Institution" orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional + - family-names: "David" + given-names: "Cedric" + affiliation: "NASA Jet Propulsion Laboratory" + orcid: "https://orcid.org/0000-0002-0915-579X" # Replace with actual ORCID if available + - family-names: "Yun" + given-names: "Kyongsik" + affiliation: "NASA Jet Propulsion Laboratory" + orcid: "https://orcid.org/0000-0002-1788-8502" # Replace with actual ORCID if available url: "https://github.com/username/repository" repository-code: "https://github.com/username/repository" license: "LICENSE-NAME" # e.g., "Apache-2.0", "MIT", etc. @@ -118,7 +143,6 @@ references: --- - ## Frequently Asked Questions (FAQ) - Q: Why is a Code of Conduct important for projects? @@ -142,6 +166,8 @@ references: **Authorship**: - [Rishi Verma](https://github.com/riverma) +- [Cedric David](https://github.com/c-h-david) +- [Kyongsik Yun](https://github.com/yunks128/) **Acknowledgements**: * Inspired by the [Contributor Covenant](https://www.contributor-covenant.org). @@ -150,4 +176,4 @@ references: ## Feedback and Contributions -Your feedback and contributions are welcome to enhance this guide. See our [contribution guidelines](https://nasa-ammos.github.io/slim/docs/contribute/contributing/). +Your feedback and contributions are welcome to enhance this guide. See our [contribution guidelines](https://nasa-ammos.github.io/slim/docs/contribute/contributing/). \ No newline at end of file diff --git a/static/assets/governance/code-of-conduct/CITATION.cff b/static/assets/governance/code-of-conduct/CITATION.cff index 0bf7138b..33bb1153 100644 --- a/static/assets/governance/code-of-conduct/CITATION.cff +++ b/static/assets/governance/code-of-conduct/CITATION.cff @@ -1,92 +1,38 @@ -# This CITATION.cff file is a template. -# Replace placeholders with your specific project information. - -# Basic required fields -cff-version: 1.2.0 # Use the current CFF version +# CITATION.cff - This file provides citation information for your project +cff-version: 1.2.0 message: "If you use this software, please cite it as below." -type: software # Options include: software, dataset, article, etc. - -# Project identifiers +type: software title: "Title of Your Software" -version: "1.0.0" # Your software version -date-released: "YYYY-MM-DD" # Release date -doi: "10.xxxx/xxxxx" # Digital Object Identifier (if available) - -# Description fields -abstract: "A brief abstract describing your software (1-2 sentences)." -description: > - A more detailed description of your software that can span - multiple lines. Explain what your software does, why it's - useful, and any other relevant information. - -# Project URLs -url: "https://github.com/username/repository" # Project homepage -repository-code: "https://github.com/username/repository" # Code repository -repository-artifact: "https://username.github.io/repository" # Project website -documentation: "https://username.github.io/repository/docs" # Documentation - -# License information -license: "MIT" # License identifier: MIT, Apache-2.0, GPL-3.0, etc. - -# Authors +version: "1.0.0" +date-released: "YYYY-MM-DD" +abstract: "A brief abstract describing your software." authors: - family-names: "Last Name" given-names: "First Name" - email: "email@example.com" # Optional - affiliation: "Your Institution" # Optional + affiliation: "Your Institution" orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional - - family-names: "Last Name 2" - given-names: "First Name 2" - email: "email2@example.com" - affiliation: "Their Institution" - orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" - -# Maintainers (if different from authors) -maintainers: - - family-names: "Maintainer Last" - given-names: "Maintainer First" - email: "maintainer@example.com" - -# Funding information (optional) -funding: - - funder: - name: "Funding Organization Name" - grant-number: "Grant123" - -# Related identifiers (optional) -identifiers: - - type: "doi" - value: "10.xxxx/xxxxx" - description: "DOI for this version" - -# Keywords + - family-names: "David" + given-names: "Cedric" + affiliation: "NASA Jet Propulsion Laboratory" + orcid: "https://orcid.org/0000-0002-0915-579X" # Replace with actual ORCID if available + - family-names: "Yun" + given-names: "Kyongsik" + affiliation: "NASA Jet Propulsion Laboratory" + orcid: "https://orcid.org/0000-0002-1788-8502" # Replace with actual ORCID if available +url: "https://github.com/username/repository" +repository-code: "https://github.com/username/repository" +license: "LICENSE-NAME" # e.g., "Apache-2.0", "MIT", etc. keywords: - "keyword1" - "keyword2" - "keyword3" - -# Related works +# For software related to published research, include the reference: references: - - type: "article" # Can be: article, book, software, dataset, etc. + - type: "article" authors: - family-names: "Author Last" given-names: "Author First" title: "Title of the related publication" year: YYYY - journal: "Journal Name" # For articles - volume: "X" # For articles - issue: "Y" # For articles - pages: "start-end" # For articles - doi: "10.xxxx/xxxxx" # For any type with a DOI - - - type: "conference-paper" - authors: - - family-names: "Author Last" - given-names: "Author First" - title: "Title of the conference paper" - year: YYYY - conference: - name: "Name of the Conference" - address: "City, Country" # Where the conference was held - date-start: "YYYY-MM-DD" # Start date - date-end: "YYYY-MM-DD" # End date \ No newline at end of file + journal: "Journal Name" + doi: "10.xxxx/xxxxx" # If available \ No newline at end of file From d5c1fd6a44191bccecb5f4f416ffc65b39d11366 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:29:59 -0700 Subject: [PATCH 02/13] Update docs/guides/governance/contributions/code-of-conduct/README.md --- docs/guides/governance/contributions/code-of-conduct/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index ee5b4926..36db1b6c 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -25,7 +25,7 @@ ## Quick Start -**[✓️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) +**[⬇️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) Access the standard Contributor Covenant template for a robust Code of Conduct policy to use in your project. From d6de9202906f2095e8818e7533a44f46299607b7 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:30:18 -0700 Subject: [PATCH 03/13] Update docs/guides/governance/contributions/code-of-conduct/README.md --- docs/guides/governance/contributions/code-of-conduct/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 36db1b6c..4d8f5466 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -29,7 +29,7 @@ Access the standard Contributor Covenant template for a robust Code of Conduct policy to use in your project. -**[✓️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** +**[⬇️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. From 3f97ea636adcdea61cbc51e8debd22770d6c3ba7 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:30:32 -0700 Subject: [PATCH 04/13] Update docs/guides/governance/contributions/code-of-conduct/README.md --- docs/guides/governance/contributions/code-of-conduct/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 4d8f5466..f6c6a7af 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -33,7 +33,7 @@ Access the standard Contributor Covenant template for a robust Code of Conduct p Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[✓️ CITATION.cff Template](#citation-file-template)** +**[⬇️ CITATION.cff Template](#citation-file-template)** Add a citation file to make your project properly citable in academic and research contexts. From 58aa4c22527abbf58f572aa13caf193d7fecaa5e Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:33:58 -0700 Subject: [PATCH 05/13] Update docs/guides/governance/contributions/code-of-conduct/README.md --- docs/guides/governance/contributions/code-of-conduct/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index f6c6a7af..8089bcd0 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -33,7 +33,7 @@ Access the standard Contributor Covenant template for a robust Code of Conduct p Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[⬇️ CITATION.cff Template](#citation-file-template)** +**[⬇️ CITATION.cff Template]([#citation-file-template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff))** Add a citation file to make your project properly citable in academic and research contexts. From 1e053d6f3cb8d9363884f68696b732d3a413a110 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:36:26 -0700 Subject: [PATCH 06/13] Fix CITATION.cff template to remove real names and keep as example only --- .../governance/code-of-conduct/CITATION.cff | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/static/assets/governance/code-of-conduct/CITATION.cff b/static/assets/governance/code-of-conduct/CITATION.cff index 33bb1153..53d1276c 100644 --- a/static/assets/governance/code-of-conduct/CITATION.cff +++ b/static/assets/governance/code-of-conduct/CITATION.cff @@ -11,14 +11,14 @@ authors: given-names: "First Name" affiliation: "Your Institution" orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional - - family-names: "David" - given-names: "Cedric" - affiliation: "NASA Jet Propulsion Laboratory" - orcid: "https://orcid.org/0000-0002-0915-579X" # Replace with actual ORCID if available - - family-names: "Yun" - given-names: "Kyongsik" - affiliation: "NASA Jet Propulsion Laboratory" - orcid: "https://orcid.org/0000-0002-1788-8502" # Replace with actual ORCID if available + - family-names: "Last Name 2" + given-names: "First Name 2" + affiliation: "Second Institution" + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional + - family-names: "Last Name 3" + given-names: "First Name 3" + affiliation: "Third Institution" + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional url: "https://github.com/username/repository" repository-code: "https://github.com/username/repository" license: "LICENSE-NAME" # e.g., "Apache-2.0", "MIT", etc. From 38b79b724a142d2f71bcbcd109c2039967c4d858 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:37:39 -0700 Subject: [PATCH 07/13] Update README.md to match the example CITATION.cff --- .../contributions/code-of-conduct/README.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 8089bcd0..60fdd9af 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -25,15 +25,15 @@ ## Quick Start -**[⬇️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) +**[✓️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) Access the standard Contributor Covenant template for a robust Code of Conduct policy to use in your project. -**[⬇️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** +**[✓️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[⬇️ CITATION.cff Template]([#citation-file-template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff))** +**[✓️ CITATION.cff Template](#citation-file-template)** Add a citation file to make your project properly citable in academic and research contexts. @@ -114,14 +114,14 @@ authors: given-names: "First Name" affiliation: "Your Institution" orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional - - family-names: "David" - given-names: "Cedric" - affiliation: "NASA Jet Propulsion Laboratory" - orcid: "https://orcid.org/0000-0002-0915-579X" # Replace with actual ORCID if available - - family-names: "Yun" - given-names: "Kyongsik" - affiliation: "NASA Jet Propulsion Laboratory" - orcid: "https://orcid.org/0000-0002-1788-8502" # Replace with actual ORCID if available + - family-names: "Last Name 2" + given-names: "First Name 2" + affiliation: "Second Institution" + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional + - family-names: "Last Name 3" + given-names: "First Name 3" + affiliation: "Third Institution" + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional url: "https://github.com/username/repository" repository-code: "https://github.com/username/repository" license: "LICENSE-NAME" # e.g., "Apache-2.0", "MIT", etc. From c254eac43c2044b5559c8de9b92d849e6f36593c Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:48:43 -0700 Subject: [PATCH 08/13] Update emoji in Quick Start --- .../governance/contributions/code-of-conduct/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 60fdd9af..3e0e6a9d 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -25,15 +25,15 @@ ## Quick Start -**[✓️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) +**[⬇️ Contributor Covenant Template](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md)** ([see example](https://github.com/riverma/terraformly/blob/main/CODE_OF_CONDUCT.md)) Access the standard Contributor Covenant template for a robust Code of Conduct policy to use in your project. -**[✓️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** +**[⬇️ CODE_OF_COLLAB.md Template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CODE_OF_COLLAB.md)** Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[✓️ CITATION.cff Template](#citation-file-template)** +**[⬇️ CITATION.cff Template](#citation-file-template)** Add a citation file to make your project properly citable in academic and research contexts. From c94e331d0a93b15a9ffd4d33a20e120313bb5da8 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:51:18 -0700 Subject: [PATCH 09/13] Restore all original content in CITATION.cff but with generic placeholders --- .../governance/code-of-conduct/CITATION.cff | 91 +++++++++++++++---- 1 file changed, 75 insertions(+), 16 deletions(-) diff --git a/static/assets/governance/code-of-conduct/CITATION.cff b/static/assets/governance/code-of-conduct/CITATION.cff index 53d1276c..740f89b3 100644 --- a/static/assets/governance/code-of-conduct/CITATION.cff +++ b/static/assets/governance/code-of-conduct/CITATION.cff @@ -1,38 +1,97 @@ -# CITATION.cff - This file provides citation information for your project -cff-version: 1.2.0 +# This CITATION.cff file is a template. +# Replace placeholders with your specific project information. + +# Basic required fields +cff-version: 1.2.0 # Use the current CFF version message: "If you use this software, please cite it as below." -type: software +type: software # Options include: software, dataset, article, etc. + +# Project identifiers title: "Title of Your Software" -version: "1.0.0" -date-released: "YYYY-MM-DD" -abstract: "A brief abstract describing your software." +version: "1.0.0" # Your software version +date-released: "YYYY-MM-DD" # Release date +doi: "10.xxxx/xxxxx" # Digital Object Identifier (if available) + +# Description fields +abstract: "A brief abstract describing your software (1-2 sentences)." +description: > + A more detailed description of your software that can span + multiple lines. Explain what your software does, why it's + useful, and any other relevant information. + +# Project URLs +url: "https://github.com/username/repository" # Project homepage +repository-code: "https://github.com/username/repository" # Code repository +repository-artifact: "https://username.github.io/repository" # Project website +documentation: "https://username.github.io/repository/docs" # Documentation + +# License information +license: "MIT" # License identifier: MIT, Apache-2.0, GPL-3.0, etc. + +# Authors authors: - family-names: "Last Name" given-names: "First Name" - affiliation: "Your Institution" + email: "email@example.com" # Optional + affiliation: "Your Institution" # Optional orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional - family-names: "Last Name 2" given-names: "First Name 2" + email: "email2@example.com" affiliation: "Second Institution" - orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" - family-names: "Last Name 3" given-names: "First Name 3" + email: "email3@example.com" affiliation: "Third Institution" - orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" # Optional -url: "https://github.com/username/repository" -repository-code: "https://github.com/username/repository" -license: "LICENSE-NAME" # e.g., "Apache-2.0", "MIT", etc. + orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" + +# Maintainers (if different from authors) +maintainers: + - family-names: "Maintainer Last" + given-names: "Maintainer First" + email: "maintainer@example.com" + +# Funding information (optional) +funding: + - funder: + name: "Funding Organization Name" + grant-number: "Grant123" + +# Related identifiers (optional) +identifiers: + - type: "doi" + value: "10.xxxx/xxxxx" + description: "DOI for this version" + +# Keywords keywords: - "keyword1" - "keyword2" - "keyword3" -# For software related to published research, include the reference: + +# Related works references: - - type: "article" + - type: "article" # Can be: article, book, software, dataset, etc. authors: - family-names: "Author Last" given-names: "Author First" title: "Title of the related publication" year: YYYY - journal: "Journal Name" - doi: "10.xxxx/xxxxx" # If available \ No newline at end of file + journal: "Journal Name" # For articles + volume: "X" # For articles + issue: "Y" # For articles + pages: "start-end" # For articles + doi: "10.xxxx/xxxxx" # For any type with a DOI + + - type: "conference-paper" + authors: + - family-names: "Author Last" + given-names: "Author First" + title: "Title of the conference paper" + year: YYYY + conference: + name: "Name of the Conference" + address: "City, Country" # Where the conference was held + date-start: "YYYY-MM-DD" # Start date + date-end: "YYYY-MM-DD" # End date \ No newline at end of file From 0c0c62ddaef3a8a0ac505a86af010cb074289100 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 15 May 2025 00:53:10 -0700 Subject: [PATCH 10/13] Update docs/guides/governance/contributions/code-of-conduct/README.md --- docs/guides/governance/contributions/code-of-conduct/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 3e0e6a9d..3d4ae974 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -33,7 +33,7 @@ Access the standard Contributor Covenant template for a robust Code of Conduct p Add a supplementary collaboration policy specifically designed for scientific research environments, addressing publication ethics, authorship, and research integrity. -**[⬇️ CITATION.cff Template](#citation-file-template)** +**[⬇️ CITATION.cff Template]([#citation-file-template](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff))** Add a citation file to make your project properly citable in academic and research contexts. From 392edb0ec568690502092a30449057ea697d2ecf Mon Sep 17 00:00:00 2001 From: Kyongsik Yun Date: Thu, 15 May 2025 10:57:12 -0700 Subject: [PATCH 11/13] CITATION file fix --- CITATION.cff | 80 ++++++++++++++++++++++++++++------------------------ 1 file changed, 43 insertions(+), 37 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index ade97c4b..26617817 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,39 +1,45 @@ -cff-version: 1.0.0 -message: "If you use this software, please cite it as below." +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: Software Lifecycle Improvement & Modernization (SLIM) +message: 'If you use this software, please cite it as below.' type: software -title: "Software Lifecycle Improvement & Modernization (SLIM)" -abstract: "A shared community resource for discussing, iterating and referencing a common set of best practices in software development standards for NASA multi-mission space and ground software." -version: "1.0.0" -date-released: "2025-04-30" -url: "https://github.com/NASA-AMMOS/slim" -repository-code: "https://github.com/NASA-AMMOS/slim" -repository-artifact: "https://nasa-ammos.github.io/slim/" -license: "Apache-2.0" -references: - - type: conference-paper - authors: - - family-names: "Verma" - given-names: "Rishi" - - family-names: "Yun" - given-names: "Kyongsik" - - family-names: "Ramirez" - given-names: "Paul" - title: "Open Source Community-Built Software Standards for Space and Ground Software. An Overview of the Software Lifecycle Improvement & Modernization (SLIM) Project from NASA's Jet Propulsion Laboratory" - year: 2025 - conference: - name: "SpaceOps" - address: "Conference Location" - date-start: "2025-05-26" - date-end: "2025-05-30" +authors: + - {} + - given-names: Rishi + family-names: Verma + affiliation: JPL + - given-names: Kyongsik + family-names: Yun + affiliation: JPL + - given-names: Paul + family-names: Ramirez + affiliation: JPL +identifiers: + - type: url + value: 'https://github.com/NASA-AMMOS/slim' + - type: url + value: 'https://nasa-ammos.github.io/slim/' +repository-code: 'https://github.com/NASA-AMMOS/slim' +url: 'https://github.com/NASA-AMMOS/slim' +repository-artifact: 'https://nasa-ammos.github.io/slim/' +abstract: >- + A shared community resource for discussing, iterating and + referencing a common set of best practices in software + development standards for NASA multi-mission space and + ground software. keywords: - - "software lifecycle" - - "software standards" - - "NASA" - - "JPL" - - "AMMOS" - - "space software" - - "ground software" - - "best practices" - - "software governance" - - "documentation standards" -description: "The Software Lifecycle Improvement & Modernization (SLIM) project provides sample scripts, configuration, documentation, and recommendations for best practices in software lifecycle modernization, software governance improvements and standards, as well as software information sharing consistency and standards for NASA multi-mission space and ground software." \ No newline at end of file + - software lifecycle + - software standards + - NASA + - JPL + - AMMOS + - space software + - ground software + - best practices + - software governance + - documentation standards +license: Apache-2.0 +version: 1.0.0 +date-released: '2025-04-30' From 976ac8b2e10fd3996d590123a21cb062ee4abf80 Mon Sep 17 00:00:00 2001 From: Kyongsik Yun Date: Thu, 15 May 2025 11:03:11 -0700 Subject: [PATCH 12/13] CITATION file fix --- CITATION.cff | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 26617817..be663964 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -6,16 +6,10 @@ title: Software Lifecycle Improvement & Modernization (SLIM) message: 'If you use this software, please cite it as below.' type: software authors: - - {} - - given-names: Rishi - family-names: Verma - affiliation: JPL - - given-names: Kyongsik - family-names: Yun - affiliation: JPL - - given-names: Paul - family-names: Ramirez - affiliation: JPL + - family-names: 'NASA AMMOS' + given-names: 'NASA Advanced Multi-Mission Operations System' + orcid: '0000-0002-1234-5678' + affiliation: 'NASA' identifiers: - type: url value: 'https://github.com/NASA-AMMOS/slim' From 4a03e7bd46112d7f771f91b1a413cc16b19ecf03 Mon Sep 17 00:00:00 2001 From: Kyongsik Yun Date: Thu, 15 May 2025 11:04:24 -0700 Subject: [PATCH 13/13] CITATION file fix --- CITATION.cff | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index be663964..26617817 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -6,10 +6,16 @@ title: Software Lifecycle Improvement & Modernization (SLIM) message: 'If you use this software, please cite it as below.' type: software authors: - - family-names: 'NASA AMMOS' - given-names: 'NASA Advanced Multi-Mission Operations System' - orcid: '0000-0002-1234-5678' - affiliation: 'NASA' + - {} + - given-names: Rishi + family-names: Verma + affiliation: JPL + - given-names: Kyongsik + family-names: Yun + affiliation: JPL + - given-names: Paul + family-names: Ramirez + affiliation: JPL identifiers: - type: url value: 'https://github.com/NASA-AMMOS/slim'