Skip to content

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

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

[Fix] Citation File Template rendering and update authors #193

wants to merge 13 commits into from

Conversation

@riverma
Copy link
Collaborator

@riverma riverma commented May 15, 2025

Purpose

This PR addresses issues with the Citation File Template in the Code of Conduct best practice guide.

Proposed Changes

  • [FIX] YAML code rendering in the Citation File Template section by properly using fenced code blocks with explicit yaml syntax highlighting.
  • [FIX] CITATION.cff file format to ensure it can be correctly parsed by GitHub and other tools.
  • [ADD] Added Cedric David and Kyongsik Yun as authors in both the guide's credits section and the template CITATION.cff file.
  • [CHANGE] Renamed "Additional Guidance on Scientific Collaboration" section to "Code of Collaboration" and restructured it as a more detailed step-by-step guide.

Issues

Testing

  • Verified the YAML code block now properly renders in markdown preview
  • Validated the CITATION.cff file with the CITATION.cff validator
  • Tested the document structure and links

riverma
riverma commented May 15, 2025
View reviewed changes
riverma
riverma commented May 15, 2025
View reviewed changes
riverma
riverma commented May 15, 2025
View reviewed changes
riverma
riverma commented May 15, 2025
View reviewed changes
@riverma
Copy link
Collaborator Author

riverma commented May 15, 2025

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:

  1. Fixed the YAML code rendering in the Citation File Template section
  2. Updated the CITATION.cff file format to ensure proper parsing
  3. The authorship section in the Credits part of the guide still includes the requested authors
  4. Renamed and restructured the "Additional Guidance on Scientific Collaboration" section to "Code of Collaboration"

@riverma
Copy link
Collaborator Author

riverma commented May 15, 2025

I've updated the Quick Start section to use the downward arrow emoji (⬇️) instead of the checkmark emoji in all three template links.

riverma
riverma commented May 15, 2025
View reviewed changes
@riverma riverma requested a review from yunks128 May 15, 2025 07:53
yunks128
yunks128 reviewed May 15, 2025
View reviewed changes
docs/guides/governance/contributions/code-of-conduct/README.md
## 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
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.

yunks128
yunks128 reviewed May 15, 2025
View reviewed changes
docs/guides/governance/contributions/code-of-conduct/README.md
### [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
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.

yunks128
yunks128 reviewed May 15, 2025
View reviewed changes
docs/guides/governance/contributions/code-of-conduct/README.md

**Authorship**:
- [Rishi Verma](https://github.com/riverma)
- [Cedric David](https://github.com/c-h-david)
Copy link
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!

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@riverma riverma added low complexity Ticket is relatively easy & straightforward to resolve more requested Requested by community members at a medium level governance Process improvements involving coordinating, delegating, estimating, organizing / running projects labels Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yunks128 yunks128 yunks128 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

governance Process improvements involving coordinating, delegating, estimating, organizing / running projects low complexity Ticket is relatively easy & straightforward to resolve more requested Requested by community members at a medium level

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@riverma @yunks128