ba4cfc0e61
* test: run the suite under pytest-xdist and fix the isolation bugs that exposed (#171) * test: address review — cgroup+affinity-aware worker count, dedupe cuda_available, close remaining isolation leaks (#171) * test: fix cpu_topology cross-platform breakage, cover the fallback branches, correct CONTRIBUTING (#171) * test: -n auto no longer returns a single worker on one physical core (#171)
3.4 KiB
Contributing to Talemate
About This Project
Talemate is a personal hobbyist project that I maintain in my spare time. While I appreciate the community's interest and contributions, please understand that:
- This is primarily a passion project that I enjoy working on myself
- I have limited time for code reviews and prefer to spend that time developing fixes or new features myself
- Large contributions require significant review and testing time that takes away from my own development
For these reasons, I've established contribution guidelines that balance community involvement with my desire to actively develop the project myself.
Contribution Policy
I welcome small bugfix and small feature pull requests! If you've found a bug and have a fix, or have a small feature improvement, I'd love to review it.
However, please note that I am not accepting large refactors or major feature additions at this time. This includes:
- Major architectural changes
- Large new features or significant functionality additions
- Large-scale code reorganization
- Breaking API changes
- Features that would require significant maintenance
What is accepted
✅ Small bugfixes - Fixes for specific, isolated bugs
✅ Small features - Minor improvements that don't break existing functionality
✅ Documentation fixes - Typo corrections, clarifications in existing docs
✅ Minor dependency updates - Security patches or minor version bumps
What is not accepted
❌ Major features - Large new functionality or systems
❌ Large refactors - Code reorganization or architectural changes
❌ Breaking changes - Any changes that break existing functionality
❌ Major dependency changes - Framework upgrades or replacements
Submitting a PR
If you'd like to submit a bugfix or small feature:
- Open an issue first - Describe the bug you've found or feature you'd like to add
- Keep it small - Focus on one specific issue or small improvement
- Follow existing code style - Match the project's current patterns
- Don't break existing functionality - Ensure all existing tests pass
- Include tests - Add or update tests that verify your fix or feature
- Update documentation - If your changes affect behavior, update relevant docs
Testing
Ensure all tests pass by running:
uv run pytest tests/ -p no:warnings
The test dependencies live in the dev extra, which is not installed by
default — install it once with either of:
uv sync --extra dev
uv pip install -e ".[dev]"
Plain uv sync does not just skip the extra, it removes it: run against a
working environment it uninstalls pytest, pytest-xdist and pytest-asyncio,
breaking the command above.
The suite runs distributed across your CPU cores by default (via pytest-xdist).
If your environment predates that — pytest installed, pytest-xdist not — pytest
exits with error: unrecognized arguments: -n --dist worksteal; install the dev
extra as above.
Workers discard -s / --capture=no stdout entirely (stderr, including
logging, still comes through but out of order), and failures are reordered.
Pass -n0 to run serially while debugging a specific test:
uv run pytest tests/ -n0 -s -x
Questions?
If you're unsure whether your contribution would be welcome, please open an issue to discuss it first. This saves everyone time and ensures alignment with the project's direction.