[Doc] Add Citation Information #1991
Merged
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.
Pull Request Overview
This PR adds comprehensive citation information to the flowR project, including publication details and BibTeX entries for academic papers related to flowR. The changes primarily introduce a new publications section to the README and create a standardized CITATION.cff file for automated citation metadata.
Key Changes
- Added a dedicated "Publications on flowR" section with three main publications and two related works
- Created a CITATION.cff file with complete software citation metadata including all authors and related DOIs
- Updated performance metrics throughout the README (timing changes from regenerated examples)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/documentation/print-readme.ts | Adds publication data structures and rendering logic to generate the publications section in the README |
| README.md | Incorporates the new publications section with BibTeX citations and updates example output timings |
| CITATION.cff | New file providing standardized citation metadata for the software following CFF format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
This pull request is included in v2.6.2 (see Release v2.6.2 (TS-Queries, new Domain Structure, more Reserved Words, removed Lineage Query)). |
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.
Check out the new readme:
https://github.com/flowr-analysis/flowr/blob/15654b718d7c5c428fb0817cee9426e3d6aa5f08/README.md