Skip to content

chore: the project configuration and documentation#88

Merged
dcruzf merged 4 commits intomainfrom
dev
Feb 9, 2026
Merged

chore: the project configuration and documentation#88
dcruzf merged 4 commits intomainfrom
dev

Conversation

@dcruzf
Copy link
Owner

@dcruzf dcruzf commented Feb 9, 2026

This pull request introduces improvements to the project configuration and documentation, focusing on enhancing testing workflows and clarifying contribution guidelines. The most important changes are grouped below by theme:

Testing and coverage enhancements:

  • Added coverage to the dependencies list and introduced a new script html-report for generating coverage reports in HTML format, which will be saved to docs/assets/cov/.
  • Streamlined the all script under [tool.hatch.envs.default.scripts] for running pre-commit checks, making it easier to execute all checks at once.

Documentation and packaging updates:

  • Updated the contribution guide in docs/guide.md to reference contributing.md for more information, helping contributors find detailed instructions.
  • Removed /Makefile from the list of files included in source distributions, simplifying packaging and ensuring only necessary files are shipped.

@dcruzf dcruzf self-assigned this Feb 9, 2026
@dcruzf dcruzf added the documentation Improvements or additions to documentation label Feb 9, 2026
@dcruzf dcruzf merged commit 9b954ac into main Feb 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant