Skip to content

Conversation

@HakanAcundas
Copy link
Contributor

@HakanAcundas HakanAcundas commented Aug 21, 2025

Description

Refactoring folder layout.
Moving libCZIPublicHeaders files into the newly created inc directory for separate the public and private header files.

Fixes # (issue)

Type of change

Refactoring folder layout

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

With the new folder layout, I run unit tests of libczi and downstream projects (LibCZI_NET, imgdoc2).

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I updated the version of libCZI following Versioning of libCZI depending on the type of change
    • Bug fix -> PATCH
    • New feature -> MINOR
    • Breaking change -> MAJOR
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@codecov
Copy link

codecov bot commented Aug 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.08%. Comparing base (cc79cff) to head (997968e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #150   +/-   ##
=======================================
  Coverage   66.08%   66.08%           
=======================================
  Files          88       88           
  Lines       11265    11265           
=======================================
  Hits         7445     7445           
  Misses       3820     3820           
Flag Coverage Δ
windows-latest 66.08% <ø> (ø)

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

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

@HakanAcundas HakanAcundas marked this pull request as ready for review August 21, 2025 09:09
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder whether line 422-423 needs to be adapted as well. I guess we'll need to test a vcpkg-build for this.

@ptahmose
Copy link
Contributor

I wonder... while we are at it, should we move all other files in the the libCZI-folder (i.e. everything but the new inc-folder) into a new folder "src" (or something like this). Would this look "more tidy"?

@ptahmose ptahmose added the cla Contributor License Agreement sent to Admin label Aug 22, 2025
@HakanAcundas
Copy link
Contributor Author

I wonder... while we are at it, should we move all other files in the the libCZI-folder (i.e. everything but the new inc-folder) into a new folder "src" (or something like this). Would this look "more tidy"?

I think the same, since together with src folder, people will understand the purpose of the folders more easily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla Contributor License Agreement sent to Admin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants