Add CITATION.cff file for authorship and references #8
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
Shaanworkspace marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||||||||||||||||||||
|
Comment on lines
+6
to
+13
There was a problem hiding this comment. The ORCID's don't match the names given here. We should avoid adding those who may not have project affiliation.
Suggested change
|
||||||||||||||||||||
| 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" | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| url: "https://openai.com/gpt-4" | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| type: "article" | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| authors: | ||||||||||||||||||||
| - family-names: "OpenAI" | ||||||||||||||||||||
| given-names: "GPT-4 Team" | ||||||||||||||||||||
|
Comment on lines
+26
to
+27
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| year: 2023 | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| - title: "Original Repository by eyermt" | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| url: "https://github.com/eyermt/repo-name" | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| type: "software" # Use 'software' type | ||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| authors: | ||||||||||||||||||||
| - family-names: "eyermt" | ||||||||||||||||||||
| given-names: "eyermt" | ||||||||||||||||||||
|
Comment on lines
+33
to
+34
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| year: 2023 | ||||||||||||||||||||
|
There was a problem hiding this comment. So far as I can see, the repository was started in 2024. It might be worth confirming this with @eyermt .
Suggested change
|
||||||||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
referencessection 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.