Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
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
50 changes: 38 additions & 12 deletions docs/guides/governance/contributions/code-of-conduct/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Comment thread
riverma marked this conversation as resolved.
Outdated

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)**
Comment thread
riverma marked this conversation as resolved.
Outdated

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)**
Comment thread
riverma marked this conversation as resolved.
Outdated

Add a citation file to make your project properly citable in academic and research contexts.

Expand All @@ -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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like you tried to autogenerate a pull request @riverma
The link should stay the same.


- 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.

---

Expand All @@ -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

<a id="citation-file-template"></a>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that this line caused the rendering problem. My mistake. We should remove this line, and I confirmed the readme renders well locally using yarn start.


```yaml
# CITATION.cff - This file provides citation information for your project
cff-version: 1.2.0
Expand All @@ -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.
Expand All @@ -118,7 +143,6 @@ references:

---


## Frequently Asked Questions (FAQ)

- Q: Why is a Code of Conduct important for projects?
Expand All @@ -142,6 +166,8 @@ references:

**Authorship**:
- [Rishi Verma](https://github.com/riverma)
- [Cedric David](https://github.com/c-h-david)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding additional authors!

- [Kyongsik Yun](https://github.com/yunks128/)

**Acknowledgements**:
* Inspired by the [Contributor Covenant](https://www.contributor-covenant.org).
Expand All @@ -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/).
98 changes: 22 additions & 76 deletions static/assets/governance/code-of-conduct/CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
journal: "Journal Name"
doi: "10.xxxx/xxxxx" # If available