Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added citation #283

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Added citation #283

merged 1 commit into from
Nov 15, 2023

Conversation

jkbhagatio
Copy link
Member

@jkbhagatio jkbhagatio commented Nov 15, 2023

Summary by CodeRabbit

  • Documentation: Added citation information to CITATION.cff and readme.md. This includes details such as version, message, authors, title, DOI, release date, and URL.
  • New Feature: Introduced a citation policy to the codebase. This will guide users on how to properly cite this software in their research or projects. The policy includes citation text and a DOI badge for easy reference.

Co-authored-by: Dario Campagner <[email protected]>
Copy link

github-actions bot commented Nov 15, 2023

Image description CodeRabbit

Walkthrough

The overall change involves the addition of citation information and a citation policy to the codebase. This includes details such as version, message, authors, title, DOI, release date, and URL. The citation policy also includes a citation text and a DOI badge. These changes are aimed at providing clear and concise citation guidelines for anyone who wishes to reference this project in their work.

Changes

Files Summary
CITATION.cff, readme.md Added citation information including the version, message, authors, title, DOI, release date, and URL. Also added a citation policy to the codebase, including a citation text and a DOI badge.

Uplevel your code reviews with CodeRabbit Pro

CodeRabbit Pro

If you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects.

@jkbhagatio jkbhagatio merged commit 50d9dc4 into main Nov 15, 2023
5 of 7 checks passed
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

Commits Files that changed from the base of the PR and between bba4cab and 6a5f9d7 commits.
Files selected (2)
  • CITATION.cff (1)
  • readme.md (1)
Files skipped from review due to trivial changes (2)
  • CITATION.cff
  • readme.md
Review comments generated (0)
  • Review: 0
  • LGTM: 0

Tips

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

  • Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

@jkbhagatio jkbhagatio deleted the doi branch July 23, 2024 16:36
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.

1 participant