[Fix] Citation File Template rendering and update authors #193
Conversation
|
I've updated the PR to remove real names from the CITATION.cff template file, keeping it as a generic example only. Both the static template file and the code block in the README.md have been updated to use placeholder names (Last Name, Last Name 2, Last Name 3) rather than specific individuals. The PR still addresses all the issues from the original ticket:
|
|
I've updated the Quick Start section to use the downward arrow emoji (⬇️) instead of the checkmark emoji in all three template links. |
|
|
||
| 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.
It looks like you tried to autogenerate a pull request @riverma
The link should stay the same.
| - 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.
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.
| @@ -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.
Thank you for adding additional authors!
|
Purpose
This PR addresses issues with the Citation File Template in the Code of Conduct best practice guide.
Proposed Changes
Issues
Testing