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.cff file for authorship and references #8

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/citation-file-format/cffconvert
rev: 054bda51dbe278b3e86f27c890e3f3ac877d616c
hooks:
- id: validate-cff
35 changes: 35 additions & 0 deletions CITATION.cff
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some of the basis of #5 pertained to providing credit or notice that we used LLM's in the making of this project. Consider adding a references section to this document to help begin towards referencing other work which shaped this project (I believe it may have been OpenAI models but we may want to confirm with @jring-o). It might also be worth referencing the upstream repository to help credit @eyermt and illustrate how that repository is related to this one.

Shaanworkspace marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "Map of Open Source Science (MOSS)"
version: "0.1.0"
authors:
- family-names: "Smith"
given-names: "Alice"
affiliation: "NumFOCUS"
orcid: "https://orcid.org/0000-0002-1825-0097"
- family-names: "Jones"
given-names: "Bob"
affiliation: "Open Science Initiative"
orcid: "https://orcid.org/0000-0003-1419-2405"
url: "https://github.com/numfocus/MOSS"
repository-code: "https://github.com/numfocus/MOSS"
keywords:
- open source
- science
- visualization
license: "Apache-2.0"
references:
- title: "OpenAI GPT-4"
url: "https://openai.com/gpt-4"
type: "article"
authors:
- family-names: "OpenAI"
given-names: "GPT-4 Team"
year: 2023
- title: "Original Repository by eyermt"
url: "https://github.com/eyermt/repo-name"
type: "software" # Use 'software' type
authors:
- family-names: "eyermt"
given-names: "eyermt"
year: 2023