1.7 KiB
1.7 KiB
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
</head>
</html>
Contributing to XYZ
Thank you for your interest in contributing to XYZ!
Development Setup
Clone the repository:
git clone https://github.com/USERNAME/XYZ.git cd XYZ
...
...
...
...
Code Style
This project follows strict coding standards:
Formatting
- Formatter: Use yapf for code formatting
- Linter: Use ruff for linting only (not formatting)
- Type hints: Full type hints everywhere using modern syntax (str | None, list[str])
- Docstrings: Vertical multi-line format only
- Imports: Vertical multi-line for 2+ imports with trailing commas
- Constants: All magic numbers and strings must be constants or enums
Run formatters and linters
# Format code yapf -ir src/ # Lint ruff check src/ # Type check mypy src/
Testing
Run tests before submitting:
uv run pytest
Pull Request Process
- Create a feature branch from main
- Make your changes following code style guidelines
- Add tests for new functionality
- Ensure all tests pass
- Update documentation if needed
- Submit a pull request
Commit Messages
Use conventional commit format:
- feat: New features
- fix: Bug fixes
- docs: Documentation changes
- refactor: Code refactoring
- test: Test additions/changes
- chore: Maintenance tasks
Example:
feat: XYZ - XYZ - XYZ - XYZ
Questions?
Open an issue or reach out to the maintainers!