Skip to content

Conversation

@DavidKerkmann
Copy link
Member

@DavidKerkmann DavidKerkmann commented Mar 24, 2025

Minor improvements to the ABM readme.

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Minor changes to the wording in the ABM readme.

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Minor improvements to the ABM readme.
@DavidKerkmann DavidKerkmann added the class::documentation Improvements or additions to documentation label Mar 24, 2025
@DavidKerkmann DavidKerkmann requested a review from xsaschako March 24, 2025 10:31
@DavidKerkmann DavidKerkmann self-assigned this Mar 24, 2025
@DavidKerkmann DavidKerkmann marked this pull request as draft March 24, 2025 10:32
@DavidKerkmann DavidKerkmann marked this pull request as ready for review March 24, 2025 10:43
Copy link
Member

@xsaschako xsaschako left a comment

Choose a reason for hiding this comment

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

Thank you for the changes, looks good!

@codecov
Copy link

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.22%. Comparing base (049e8df) to head (81329b3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1234   +/-   ##
=======================================
  Coverage   97.22%   97.22%           
=======================================
  Files         154      154           
  Lines       14236    14236           
=======================================
  Hits        13841    13841           
  Misses        395      395           

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

@xsaschako xsaschako merged commit 4f6c0d0 into main Mar 24, 2025
81 checks passed
@xsaschako xsaschako deleted the update-abm-readme branch March 24, 2025 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

class::documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants