-
Notifications
You must be signed in to change notification settings - Fork 14
[Fix] Citation File Template rendering and update authors #193
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
base: main
Are you sure you want to change the base?
Changes from 9 commits
c6d6365
d5c1fd6
d6de920
3f97ea6
58aa4c2
1e053d6
38b79b7
c254eac
c94e331
0c0c62d
392edb0
976ac8b
4a03e7b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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](https://raw.githubusercontent.com/NASA-AMMOS/slim/main/static/assets/governance/code-of-conduct/CITATION.cff))** | ||
| **[⬇️ CITATION.cff Template](#citation-file-template)** | ||
riverma marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It looks like you tried to autogenerate a pull request @riverma |
||
|
|
||
| - 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 | ||
|
|
||
| <a id="citation-file-template"></a> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
|
@@ -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) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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). | ||
|
|
@@ -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/). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,12 @@ authors: | |
| - family-names: "Last Name 2" | ||
| given-names: "First Name 2" | ||
| email: "[email protected]" | ||
| 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: "[email protected]" | ||
| affiliation: "Third Institution" | ||
| orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx" | ||
|
|
||
| # Maintainers (if different from authors) | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.