Skip to content

Conversation

@kilianvolmer
Copy link
Contributor

@kilianvolmer kilianvolmer commented Aug 1, 2025

Changes and Information

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

  • centralized collection of literature references
  • general improvements and bug fixes
  • Updated team page

If need be, add additional information and what the reviewer should look out for in particular:

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 within the code (Doxygen) for new functionality has been added in the code
  • Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
  • 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).

Closes #48
Closes #1337
Closes #1334

@kilianvolmer kilianvolmer marked this pull request as draft August 1, 2025 13:52
@kilianvolmer kilianvolmer changed the title FIX: typos 1337-extend-the-documentation Aug 1, 2025
@kilianvolmer kilianvolmer marked this pull request as ready for review September 29, 2025 14:20
@codecov
Copy link

codecov bot commented Sep 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.27%. Comparing base (a1d8af8) to head (4ec2ca1).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1338      +/-   ##
==========================================
- Coverage   97.28%   97.27%   -0.02%     
==========================================
  Files         175      175              
  Lines       15306    15306              
==========================================
- Hits        14891    14889       -2     
- Misses        415      417       +2     

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

@reneSchm reneSchm linked an issue Oct 6, 2025 that may be closed by this pull request
@kilianvolmer kilianvolmer requested a review from HenrZu October 6, 2025 13:07
@HenrZu HenrZu merged commit 52ed3c1 into main Oct 7, 2025
65 of 68 checks passed
@HenrZu HenrZu deleted the 1337-extend-the-documentation branch October 7, 2025 07:35
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.

Extend the documentation Clarification for Infection State Transitions Improve documentation

10 participants