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.

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

Add CITATION file #2455

Merged
merged 4 commits into from
May 30, 2024
Merged

Add CITATION file #2455

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a4bb87
Create CITATION.cff
pavithraes May 9, 2024
8bcee8f
Add latest version and release date
pavithraes May 9, 2024
a65e595
Remove tagline
pavithraes May 9, 2024
c8b7368
Merge branch 'develop' into pavithraes-patch-1
pavithraes May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
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

type: software
title: "Nebari: Your open source data science platform"
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
url: "https://www.nebari.dev"
repository-code: "https://github.com/nebari-dev/nebari"