Add CITATION.cff file for authorship and references #8
Conversation
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
d33bs
reviewed
Jan 8, 2025
CITATION.cff
Outdated
Comment on lines
6
to
9
| - family-names: "Doe" | ||
| given-names: "John" | ||
| affiliation: "NumFOCUS" | ||
| orcid: "" |
There was a problem hiding this comment.
Consider using the real names of people who have authored this project. As-is this could be linked to a real person who has no affiliation with the project.
CITATION.cff
Outdated
| given-names: "John" | ||
| affiliation: "NumFOCUS" | ||
| orcid: "" | ||
| date-released: "2025-01-01" |
There was a problem hiding this comment.
This software has no releases yet to my knowledge. Consider removing this line.
CITATION.cff
Outdated
| - open source | ||
| - science | ||
| - visualization | ||
| license: "MIT" |
There was a problem hiding this comment.
This license isn't correct based on the license file of the project. Consider revising this to match the license type stipulated by the LICENSE file.
CITATION.cff
Outdated
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| title: "Map of Open Source Science (MOSS)" | ||
| version: "1.0.0" |
There was a problem hiding this comment.
The current version of the software stipulated by the pyproject.toml file is 0.1.0. Consider revising this to match here.
There was a problem hiding this comment.
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.
|
Dear Dave,
Thank you for your feedback. I have addressed the changes requested and
successfully validated the CITATION.cff file as per the guidelines. The
file is now passing all validation checks.
The pull request is now ready for review. Please let me know if anything
else is required.
Looking forward to your response.
Best regards,
Shaan Yadav
…On Wed, Jan 8, 2025 at 10:05 PM Dave Bunten ***@***.***> wrote:
***@***.**** commented on this pull request.
Nice addition - I left a few comments to consider. Please don't hesitate
to let me know if you have any questions. I wouldn't consider this ready to
merge yet until modifications are made due to the author section in
particular.
------------------------------
In CITATION.cff
<#8 (comment)>:
> + - family-names: "Doe"
+ given-names: "John"
+ affiliation: "NumFOCUS"
+ orcid: ""
Consider using the real names of people who have authored this project.
As-is this could be linked to a real person who has no affiliation with the
project.
------------------------------
In CITATION.cff
<#8 (comment)>:
> @@ -0,0 +1,17 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "Map of Open Source Science (MOSS)"
+version: "1.0.0"
+authors:
+ - family-names: "Doe"
+ given-names: "John"
+ affiliation: "NumFOCUS"
+ orcid: ""
+date-released: "2025-01-01"
This software has no releases yet to my knowledge. Consider removing this
line.
------------------------------
In CITATION.cff
<#8 (comment)>:
> +message: "If you use this software, please cite it as below."
+title: "Map of Open Source Science (MOSS)"
+version: "1.0.0"
+authors:
+ - family-names: "Doe"
+ given-names: "John"
+ affiliation: "NumFOCUS"
+ orcid: ""
+date-released: "2025-01-01"
+url: "https://github.com/numfocus/MOSS"
+repository-code: "https://github.com/numfocus/MOSS"
+keywords:
+ - open source
+ - science
+ - visualization
+license: "MIT"
This license isn't correct based on the license file of the project.
Consider revising this to match the license type stipulated by the LICENSE
file.
------------------------------
In CITATION.cff
<#8 (comment)>:
> @@ -0,0 +1,17 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "Map of Open Source Science (MOSS)"
+version: "1.0.0"
The current version of the software stipulated by the pyproject.toml file
is 0.1.0
<https://github.com/numfocus/MOSS/blob/main/pyproject.toml#L3C11-L3C18>.
Consider revising this to match here.
------------------------------
On CITATION.cff
<#8 (comment)>:
Some of the basis of #5 <#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
<https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#referencing-other-work>
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 <https://github.com/jring-o>). It might also be worth
referencing the upstream repository to help credit @eyermt
<https://github.com/eyermt> and illustrate how that repository is related
to this one.
------------------------------
On CITATION.cff
<#8 (comment)>:
It could be very helpful to consider using pre-commit with cffvalidate
<https://github.com/citation-file-format/cffconvert?tab=readme-ov-file#pre-commit-hook>.
Pre-commit <https://pre-commit.com/> provides a set of formatting and
linting tools. cffconvert
<https://github.com/citation-file-format/cffconvert> is a project which
is useful for validating the format of CITATION.cff files (in addition to
other tasks). Pre-commit checks can be applied manually, part of git
workflows, or part of CI. Using a cffconvert through pre-commit to validate
the format continuously will help keep it in alignment with the CFF schema
and avoid errors from integrations which may opt to read this file.
—
Reply to this email directly, view it on GitHub
<#8 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BID2KSLYZJTX7FLLLSUYZ6T2JVHVTAVCNFSM6AAAAABUV6XPSCVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKMZXGU3TEMBTGI>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces the CITATION.cff file to the project, providing proper attribution and citation information for the software. The CITATION.cff file contains key metadata such as the project title, version, release date, and authorship details. This file allows users to cite the project in their own works, ensuring proper credit is given to contributors.
By adding this file, we encourage users and developers to follow best practices in citation and recognition for the software used in their research, applications, or other professional work. It also aligns with open-source standards for ensuring that software is cited correctly in academic and scientific contexts.