Skip to content

Conversation

@mknaranja
Copy link
Member

@mknaranja mknaranja commented May 23, 2025

Changes and Information

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

  • Updated and enhanced the documentation
  • Updated the PR template for better visibility of the documentation needs
  • Replaced READMEs in the model folders by links to corresponding documentation and code examples
  • minor bugfixes

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

Closes #1233

kilianvolmer and others added 30 commits March 24, 2025 13:30
…mpMod/memilio into 1233-Further-enhance-read-the-docs
Copy link
Contributor

@HenrZu HenrZu left a comment

Choose a reason for hiding this comment

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

As discussed in our meeting. Review will be done on another branch

@HenrZu HenrZu merged commit 6c83abd into main Jun 30, 2025
69 checks passed
@HenrZu HenrZu deleted the 1233-Further-enhance-read-the-docs branch June 30, 2025 09:40
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.

Further enhance the read the docs documentation Extend read the docs documentation

9 participants