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

Add CITATION file #2455

Merged
merged 4 commits into from
May 30, 2024
Merged

Add CITATION file #2455

merged 4 commits into from
May 30, 2024

Conversation

pavithraes
Copy link
Member

Reference Issues or PRs

N/A

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe): Citation file to use in scientific publications

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Any other comments?

CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Outdated Show resolved Hide resolved
@pavithraes pavithraes added the needs: review 👀 This PR is complete and ready for reviewing label May 9, 2024
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- name: "Nebari Development Team"
Copy link
Member

Choose a reason for hiding this comment

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

@pavithraes I'm not familiar with the .cff syntax but looking at the docs, it seems one should pass family-names and/or given-names. Looking at the pandas example, it's also using the latter syntax. If passing name works, I don't mind leaving it like it is now.

Otherwise, it looks good to me. Thank you!

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for taking a look. IIUC, the family-names and given-names syntax is for specific individuals, and we can use name to refer to a group. Ref: Line #9 in this examples

Copy link
Member

@marcelovilla marcelovilla left a comment

Choose a reason for hiding this comment

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

Thanks @pavithraes !

@viniciusdc
Copy link
Contributor

@marcelovilla feel free to merge, I don't see any issues with including this as part of the final cut

@marcelovilla marcelovilla merged commit 7352da2 into develop May 30, 2024
2 checks passed
@marcelovilla marcelovilla deleted the pavithraes-patch-1 branch May 30, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: community 🪴 needs: review 👀 This PR is complete and ready for reviewing type: enhancement 💅🏼 New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

3 participants