chore: Add CONTRIBUTING.md #734
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive CONTRIBUTING.md file to document the contribution process for the python-roborock project. The document covers setup instructions using uv, development workflow, testing, and guidelines for adding new devices or features.
- Establishes development environment setup with
uvand pre-commit hooks - Documents code quality tools (Ruff, Mypy, Codespell) and testing with pytest
- Provides clear guidelines for conventional commits and instructions for adding new device support
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 1. **Update Device Info**: Use the CLI to discover and fetch device features. | ||
| ```bash | ||
| roborock get-device-info |
There was a problem hiding this comment.
The CLI command should use hyphens instead of underscores. Click (the CLI framework used by this project) automatically converts underscores in Python function names to hyphens in the command-line interface. Since the function is named 'get_device_info', the actual command should be 'roborock get-device-info'.
|
Can you add info for activating the venv before pre commit install? |
Done. |
allenporter
force-pushed
the
contributing
branch
from
c17bcaa to
d4e9846
Compare
2 participants
Document things like uv, pytest, where test data json files are. This can be improved (e.g. explaining how to test, use tooling, etc) but documenting what we have for now.