Skip to content
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

Create citation.cff for DART #658

Merged
merged 5 commits into from
Mar 27, 2024
Merged

Conversation

ann-norcio
Copy link
Collaborator

@ann-norcio ann-norcio commented Mar 21, 2024

Description:

Add a citation.cff file to help users correctly cite DART software. Creates a link to cite the repository on the landing page sidebar.

Fixes issue

fixes #643

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Followed citation file formatting on Github Docs

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

Adding a citation file to help user correctly cite DART.
@mgharamti
Copy link
Contributor

Nice!

Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

Looks like there is something something funky in the .cff
Screen Shot 2024-03-21 at 2 44 32 PM

@ann-norcio
Copy link
Collaborator Author

Changed date-released format to "YYY-MM-DD" and names to name. Should work as expected now.
cff

Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

I think this looks good Ann (one change for the doi entry: APA puts the http://doi.org in for you and Bibtex recommends the 10.XXXXX only).

I think if @moha is ok with how the citation looks it is good to go.

CITATION.cff Outdated Show resolved Hide resolved
@hkershaw-brown
Copy link
Member

mgharamti

oops @ the wrong moha @mgharamti

@mgharamti
Copy link
Contributor

This looks good to me. Thanks Ann and Helen!

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Mar 22, 2024
@hkershaw-brown hkershaw-brown mentioned this pull request Mar 22, 2024
15 tasks
@mjs2369 mjs2369 changed the base branch from main to airs-converter-docs March 27, 2024 22:58
@mjs2369 mjs2369 merged commit cd249bf into NCAR:airs-converter-docs Mar 27, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release! bundle with next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: make it easier to cite DART software
4 participants