Add GitHub citation file (CITATION.cff) #383
Open
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.
Description
This PR adds a
CITATION.cfffile to the repository, following the guidance from the GitHub documentation on citation files and reproducing the work done in astronomy-commons/lsdb#594.What is CITATION.cff?
The Citation File Format (CFF) is a standard format for providing citation metadata for software. When a
CITATION.cfffile is present in a repository, GitHub automatically displays a "Cite this repository" button, making it easy for users to properly cite the software in their research and publications.Changes Made
CITATION.cffto the repository root with the following metadata:Benefits
Validation
The CITATION.cff file has been validated using the official
cffconverttool and meets the CFF specification version 1.2.0.Closes #[issue_number]
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.github.comcurl -s REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.