docs: add CITATION.cff and cite the published JSIAM Letters paper - #131
Conversation
Add root-level CITATION.cff (CFF 1.2.0) with software metadata matching pyproject.toml and a preferred-citation entry for the JSIAM Letters paper (vol. 18, 2026, pp. 13-16, DOI 10.14495/jsiaml.18.13). Add a Citation section to README.md with a ready-to-copy BibTeX entry and DOI / J-STAGE links. Closes #127 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 11f16081fa
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
Adds repository-level citation metadata and user-facing citation instructions so researchers can properly cite both the EllPHi software and the published JSIAM Letters paper.
Changes:
- Added a root-level
CITATION.cff(CFF 1.2.0) including software metadata and apreferred-citationfor the published article. - Added a “Citation” section to
README.mdincluding a formatted reference, DOI/J-STAGE links, and a BibTeX entry.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a “Citation” section with paper reference + BibTeX and points readers to CITATION.cff. |
| CITATION.cff | Introduces CFF metadata for GitHub’s citation widget and embeds the published paper as preferred-citation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Split the README Citation section into 'Citing the paper' and 'Citing the software', noting that GitHub's cite widget generates the paper citation via preferred-citation, and adding a ready-to-copy @software BibTeX entry. - Use a relative link to CITATION.cff so it follows the viewed ref. - Use the EllPHi branding for the CFF software title. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Summary
CITATION.cff(CFF 1.2.0) with software metadata consistent withpyproject.toml(nameellphi, author Tomoki Uda, MIT license, repository URL, version 0.1.2) and apreferred-citationof typearticlefor the published paper:README.mdwith the paper reference, a ready-to-copy BibTeX entry, DOI and J-STAGE links, and a pointer to GitHub's "Cite this repository" widget backed byCITATION.cff.Closes #127
Verification
uvx cffconvert --validate→ "Citation metadata are valid according to schema version 1.2.0."curl -sI https://doi.org/10.14495/jsiaml.18.13→ HTTP 302 redirect to the J-STAGE article page (DOI resolves)..../_article/-char/en) returns HTTP 200.Deferred
docs/) citation updates are deliberately deferred: the docs deployment is being reworked under docs: align GitHub Pages source with MkDocs deployment #118, so this PR touches onlyCITATION.cffandREADME.md.Notes
README.md(different sections).🤖 Generated with Claude Code