mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-30 12:15:56 +00:00
e2ae5cc559
* feat(skills): add IoT edge skills and align agent/instruction docs * fix(ci): handle fork permission errors in plugin structure check * fix(ci): allow intentional Spanish vocabulary in codespell * docs(skills): translate IoT edge skill content to English * fix(ci): pass codespell and README validation * chore: regenerate skills index after merge
49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
# Python Official References and Best Practices
|
|
|
|
Use these official Python resources before finalizing module architecture or implementation details.
|
|
|
|
## Official References
|
|
|
|
- Python home: <https://www.python.org/>
|
|
- Python documentation portal: <https://docs.python.org/3/>
|
|
- Python tutorial: <https://docs.python.org/3/tutorial/>
|
|
- Python language reference: <https://docs.python.org/3/reference/>
|
|
- Python standard library reference: <https://docs.python.org/3/library/>
|
|
- Python HOWTOs: <https://docs.python.org/3/howto/>
|
|
- Installing modules: <https://docs.python.org/3/installing/>
|
|
- Distributing modules: <https://docs.python.org/3/distributing/>
|
|
- PEP index: <https://peps.python.org/>
|
|
- PyPA packaging guide: <https://packaging.python.org/>
|
|
|
|
## Coding Best Practices
|
|
|
|
- Target and pin an explicit Python major/minor runtime for each deployment.
|
|
- Prefer explicit, readable code paths over clever compact logic.
|
|
- Use type hints for public interfaces and critical data transformations.
|
|
- Keep module responsibilities focused; separate protocol, business logic, and transport.
|
|
- Validate and sanitize external inputs at boundaries.
|
|
- Use structured exceptions with actionable error messages.
|
|
- Log with enough context for incident triage (correlation id, module id, message id).
|
|
|
|
## Reliability and Performance Best Practices
|
|
|
|
- Avoid blocking operations in high-frequency message paths.
|
|
- Enforce timeouts and bounded retries with exponential backoff and jitter.
|
|
- Design idempotent handlers for replay and duplicate deliveries.
|
|
- Use resource limits and monitor memory growth to prevent edge instability.
|
|
- Define graceful shutdown behavior to flush buffered state safely.
|
|
|
|
## Dependency and Supply Chain Best Practices
|
|
|
|
- Pin dependencies and document upgrade cadence.
|
|
- Prefer actively maintained libraries with clear release history.
|
|
- Track vulnerabilities and update dependencies regularly.
|
|
- Keep container images minimal and patched.
|
|
|
|
## Testing Best Practices
|
|
|
|
- Unit test parsing, validation, and routing logic.
|
|
- Add integration tests for module I/O boundaries.
|
|
- Add chaos tests for network loss, slow upstream, and restart scenarios.
|
|
- Verify rollback behavior and state recovery in deployment tests.
|