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' diff --git a/docs/guides/governance/contributions/code-of-conduct/README.md b/docs/guides/governance/contributions/code-of-conduct/README.md index 46d30973..3d4ae974 100644 --- a/docs/guides/governance/contributions/code-of-conduct/README.md +++ b/docs/guides/governance/contributions/code-of-conduct/README.md @@ -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: "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. @@ -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..740f89b3 100644 --- a/static/assets/governance/code-of-conduct/CITATION.cff +++ b/static/assets/governance/code-of-conduct/CITATION.cff @@ -38,7 +38,12 @@ authors: - family-names: "Last Name 2" given-names: "First Name 2" email: "email2@example.com" - affiliation: "Their Institution" + affiliation: "Second Institution" + 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" # Maintainers (if different from authors)