Skip to content

Conversation

@RonanB96
Copy link
Owner

@RonanB96 RonanB96 commented Jan 28, 2026

This pull request updates project documentation guidelines and workflow instructions, with a focus on stricter architectural prohibitions, clearer workflow steps, and simplified documentation practices. It introduces an explicit list of forbidden practices, clarifies the required workflow for contributions, and streamlines the documentation authoring rules for consistency and accuracy.

Major documentation and workflow updates:

Stricter architectural prohibitions and workflow:

  • .github/copilot-instructions.md: Adds an "ABSOLUTE PROHIBITIONS" section listing banned practices (such as TYPE_CHECKING blocks, hardcoded UUIDs, and untyped signatures), clarifies that violating these is not allowed, and reorganizes the workflow into concise, mandatory steps. Updates the architecture overview to emphasize framework-agnostic design, and streamlines the completion checklist to focus on key requirements. [1] [2]

Documentation guidelines simplification:

  • .github/instructions/documentation.instructions.md: Simplifies and shortens the documentation guidelines, emphasizing runnable code samples, Sphinx cross-references, and concise, active-voice writing. Reduces redundancy and points to canonical sources for docstring style and code documentation.

Linting configuration update:

  • .github/dependabot.yml: Removes pylint from the linting patterns, ensuring only the desired linters are included in automated checks.

The base class passes validate=True to _decode_value but most subclasses
were not accepting this parameter, causing TypeError when parsing.

- Add *, validate: bool = True parameter to all _decode_value methods
- Ensures consistent interface across all characteristic classes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants