New API

[JeremieGince]

Description

This pull request introduces major improvements to the project's community standards, contribution process, and CI/CD workflows. It adds comprehensive documentation for contributors, a code of conduct, issue and PR templates, and significantly modernizes the GitHub Actions workflows for building, testing, releasing, and publishing the package. The changes streamline dependency management, automate versioning and releases, and improve the developer experience.

Community Standards and Documentation:

• Added a detailed CONTRIBUTING.md to guide new contributors through setup, coding standards, and the PR process.
• Introduced a comprehensive CODE_OF_CONDUCT.md to set expectations for community behavior and inclusivity.

Issue and PR Management:

• Added GitHub issue templates for bug reports and feature requests to standardize and improve issue submissions. [1] [2]
• Added a pull request template to ensure code quality, testing, and documentation standards are met before review.

CI/CD Workflow Modernization:

• Major overhaul of the build and release workflow (build_dist.yml):
  • Upgraded to Python 3.11 and adopted the uv tool for dependency management and environment setup.
  • Automated version bumping, changelog generation, and release creation.
  • Added steps for building, checking, and publishing distributions, as well as merging changes from main to dev automatically. [1] [2]
• Added a new workflow to update the coverage badge after each push to main, ensuring up-to-date test coverage reporting.
• Updated the documentation build workflow to use Python 3.11 and uv, and to support both main and dev branches. [1] [2] [3]
• Removed the legacy PyPI publish workflow in favor of the new integrated process.

Other Minor Improvements:

• Minor cleanup in .gitattributes for consistency.

These updates collectively make the project more welcoming to contributors, automate repetitive tasks, and ensure higher code quality and reliability.

---

Checklist

Please complete the following checklist when submitting a PR. The PR will not be reviewed until all items are checked.

• All new features include a unit test.
  Make sure that the tests passed and the coverage is
  sufficient by running
  uv run pytest --session-timeout=600.
• All new functions and code are clearly documented.
• The code passes all pre-commit hooks.
  You can do this by running uvx pre-commit run --all-files.
• The code is type-checked using Mypy.
  You can do this by running uv run mypy src tests.

[github-actions]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
238	238	100%	98%	🟢

New Files

File	Coverage	Status
src/torch_pfaffian/strategies/pfaffian_det.py	100%	🟢
src/torch_pfaffian/strategies/pfaffian_parlett_reid.py	100%	🟢
src/torch_pfaffian/strategies/pfaffian_rust_parlett_reid.py	100%	🟢
TOTAL	100%	🟢

Modified Files

File	Coverage	Status
src/torch_pfaffian/init.py	100%	🟢
src/torch_pfaffian/strategies/init.py	100%	🟢
src/torch_pfaffian/strategies/pfaffian_block_det.py	100%	🟢
src/torch_pfaffian/strategies/pfaffian_fdbpf.py	100%	🟢
src/torch_pfaffian/strategies/strategy.py	100%	🟢
TOTAL	100%	🟢

updated for commit: 6b079ad by action🐍