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

fix: 📝 Update citation information and add DOI badge #1326

Merged
merged 2 commits into from
May 23, 2024
Merged

Conversation

Anselmoo
Copy link
Owner

The README.md file was updated to include a badge displaying the DOI for the software article.

All PR-Submissions:


  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open
    Pull Requests for the same
    update/change?

New ✨✨ Feature-Submissions:


  • Does your submission pass tests?
  • Have you lint your code locally prior to submission? Fixed:
  • This PR is for a new feature, not a bug fix.

Changes to ⚙️ Core-Features:


  • Have you added an explanation of what your changes do and why you'd like
    us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?

The CITATION.cff file was updated to include the preferred citation information for the software. The software should now be cited using both the article from preferred-citation and the software itself.
The README.md file was updated to include a badge displaying the DOI for the software article.
@Anselmoo Anselmoo enabled auto-merge (squash) May 23, 2024 04:57
@github-actions github-actions bot added documentation Improvements or additions to documentation root labels May 23, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

sonarcloud bot commented May 23, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2095acc) to head (7591f7e).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1326   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        44           
  Lines         4467      4467           
=========================================
  Hits          4467      4467           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@Anselmoo Anselmoo merged commit 22e889a into main May 23, 2024
33 checks passed
@Anselmoo Anselmoo deleted the update-cff branch May 23, 2024 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation root
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant