Skip to content

Conversation

Copy link

Copilot AI commented Oct 7, 2025

Description

This PR adds a CITATION.cff file 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.cff file 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

  • Added CITATION.cff to the repository root with the following metadata:
    • Project title and description
    • Authors (LINCC Frameworks)
    • Repository and documentation URLs
    • License information (MIT)
    • Relevant keywords (pandas, astronomy, time-domain, nested-data, python)

Benefits

  • Users can easily cite nested-pandas in their research
  • Citations can be exported in multiple formats (BibTeX, APA, EndNote, RIS, etc.)
  • Improves software discoverability and proper attribution
  • Follows best practices from similar astronomy projects (e.g., Astropy)

Validation

The CITATION.cff file has been validated using the official cffconvert tool 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.com
    • Triggering command: curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Add github citation file</issue_title>
<issue_description>Reproduce the work in astronomy-commons/lsdb#594 for this repository, following the guidance here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #204

💡 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.

@codecov
Copy link

codecov bot commented Oct 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.77%. Comparing base (c5cf5ee) to head (1f2df5f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #383   +/-   ##
=======================================
  Coverage   97.77%   97.77%           
=======================================
  Files          19       19           
  Lines        2024     2024           
=======================================
  Hits         1979     1979           
  Misses         45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: gitosaurus <6794831+gitosaurus@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub citation file for better reference Add GitHub citation file (CITATION.cff) Oct 7, 2025
Copilot AI requested a review from gitosaurus October 7, 2025 20:39
@gitosaurus gitosaurus marked this pull request as ready for review October 7, 2025 20:42
@gitosaurus gitosaurus requested a review from dougbrn October 7, 2025 20:42
@dougbrn dougbrn removed their request for review November 5, 2025 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add github citation file

2 participants