Correct git requirement manifest specification #2438
Conversation
…nal git library As in issue home-assistant#92 (home-assistant/actions#92) this update to documentation corrects this in line with hassfest validation.
📝 WalkthroughWalkthroughThe document Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Manifest
participant HomeAssistant
Developer->>Manifest: Define integration requirements
Manifest->>HomeAssistant: Validate integration manifest
HomeAssistant->>Manifest: Check dependencies and quality scale
HomeAssistant->>Manifest: Confirm IoT class and discovery methods
Manifest->>Developer: Return validation results
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/creating_integration_manifest.md (1)
Line range hint
1-24: Apply documentation style guidelines.To align with our documentation guidelines:
- Use bold formatting for UI strings instead of quotes
- Make instructions more direct by removing expressions of politeness
Example improvements:
- The domain is a "short name" consisting of characters and underscores. + The domain is a **short name** consisting of characters and underscores. - You should add at least your GitHub username here + Add at least your GitHub username here🧰 Tools
🪛 LanguageTool
[style] ~161-~161: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ject>.git@"] } ```<git ref>can be any git reference: branch, tag, comm...(MISSING_IT_THERE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/creating_integration_manifest.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/creating_integration_manifest.md (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🔇 Additional comments (1)
docs/creating_integration_manifest.md (1)
158-158: LGTM: Requirements format update is clear and accurate.
The updated format for git repository requirements aligns with pip's documentation and provides a clearer syntax. The example effectively demonstrates the practical usage.
Also applies to: 167-167
Proposed change
As in issue 92 for hassfest (home-assistant/actions#92) this update to documentation corrects this in line with hassfest validation.
Type of change
Additional information
Summary by CodeRabbit
creating_integration_manifest.mdto clarify structure and requirements for integration manifests.