Metadata #21
Merged
Metadata #21
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
PR Overview
This PR adds comprehensive citation metadata to the CITATION.cff file and enhances the README documentation with new License and How to Cite sections.
- Adds citation metadata in CITATION.cff
- Introduces License and How to Cite sections in README.md
Reviewed Changes
| File | Description |
|---|---|
| CITATION.cff | Added citation metadata including version, title, authors, etc. |
| README.md | Added License and How to Cite sections to improve documentation |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
README.md:11
- The citation details in the 'How to Cite' section do not align with the metadata in CITATION.cff. Please verify and align the author names and formatting (e.g., 'Andrea Sboner Lab' and 'kathryn gorski' vs. 'Kathryn Gorsky').
> Andrea Sboner, Alexandros Sigaras, Andrea Sboner Lab, Evan Fernandez, RadiumPlatypus, & kathryn gorski. (2025). eipm/bioinformatics: v1.5.1 (v1.5.1.patched20250304). Zenodo. [https://doi.org/10.5281/zenodo.14968809](https://doi.org/10.5281/zenodo.14968809)
asboner
approved these changes
Mar 4, 2025
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 includes changes to the
CITATION.cffandREADME.mdfiles to add citation information and improve documentation. The most important changes are the addition of citation metadata and new sections in the README file.Citation Information:
CITATION.cff: Added citation metadata including version, title, authors, identifiers, repository code, keywords, and license.Documentation Improvements:
README.md: Added sections for License and How to Cite, providing citation details and a link to the license file.