Skip to content

Added Docs and Codecov Improvements#32

Open
kosuri-indu wants to merge 4 commits intoJuliaHealth:masterfrom
kosuri-indu:update/audit-followup
Open

Added Docs and Codecov Improvements#32
kosuri-indu wants to merge 4 commits intoJuliaHealth:masterfrom
kosuri-indu:update/audit-followup

Conversation

@kosuri-indu
Copy link
Copy Markdown
Member

@kosuri-indu kosuri-indu commented Feb 9, 2026

This PR addresses the audit findings from issue #31 to improve documentation and community metadata for BloodFlowTrixi.jl. JuliaHealth/juliahealth.github.io#66

Changes Made

  • Created .JuliaFormatter.toml with Blue style configuration
  • Updated CONTRIBUTING.md with proper links and package-specific information
  • Enhanced README.md with:
    • Usage Examples section linking to tutorials
    • Contributing section
  • Added Codecov coverage reporting to CI workflow
  • Added coverage badge to README

Note on Coverage

The Codecov integration requires a CODECOV_TOKEN to be added as a repository secret and also configure CodeCov for BloodFlowtrixi.jl. Instructions for setup are available in the Codecov documentation. Once the token is added, future CI runs will automatically upload coverage reports to Codecov.

As I don't have repository admin access to complete this setup, I was unable to do it, so the Codecov token and setup will need to be added by the maintainer.

Note on Formatting

Any code formatting changes visible in diffs are purely from JuliaFormatter cleanup. No functional code was modified

CC: @yolhan83

@yolhan83
Copy link
Copy Markdown
Collaborator

Don't hesitate to tell me when it's ready for review, some tests are failing for now.

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 10, 2026

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@kosuri-indu
Copy link
Copy Markdown
Member Author

kosuri-indu commented Feb 10, 2026

@yolhan83 updated the code i think the tests are passing now, requesting a review here!

@yolhan83
Copy link
Copy Markdown
Collaborator

Thanks may take some times don't worry, I will try within the week 👍

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.

2 participants