docs: Add missed step for init'ed repos and resolve confusion that deps should be find out and installed manually#892
Conversation
should be find out and installed manually
📝 WalkthroughSummary by CodeRabbit
Summary by CodeRabbit
WalkthroughThe README.md file was updated to remove a duplicated section about installing dependencies and configuring custom Terraform binaries. The same content is preserved later in the document. Additionally, a note was added after the "Add configs and hooks" section, advising users to run Changes
Suggested reviewers
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolREADME.md[uncategorized] ~218-~218: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [uncategorized] ~244-~244: You might be missing the article “a” here. (AI_EN_LECTOR_MISSING_DETERMINER_A) ⏰ Context from checks skipped due to timeout of 90000ms (6)
🔇 Additional comments (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
Documentation and Community
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to clarify the installation process and resolve confusion regarding dependency installation. The key changes include:
- Removing the outdated dependency instructions.
- Reordering and reformatting the dependency list for clarity.
- Adding a note for repositories initialized before the global pre-commit hook installation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
283-290: Convert new initialization instruction into standard note blockTo maintain consistency with the rest of the docs (e.g., the
> [!NOTE]style used in Section 2), consider wrapping this new instruction in the same admonition format.Example diff:
- If this repository was initialized locally via `git init` or `git clone` _before_ - you installed the pre-commit hook globally ([step 2](#2-install-the-pre-commit-hook-globally)), - you will need to run: + > [!NOTE] + > If this repository was initialized locally via `git init` or `git clone` _before_ + > you installed the pre-commit hook globally ([step 2](#2-install-the-pre-commit-hook-globally)), + > you will need to run:
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~218-~218: Loose punctuation mark.
Context: ...ommit](https://pre-commit.com/#install), <sub><sup>[terraform`](https://www.t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: You might be missing the article “a” here.
Context: ...OpenTofu support It is possible to set custom path to terraform binary. This make...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: 🧪 Tests / pytest@🐍3.9@macos-14
- GitHub Check: 🧪 Tests / pytest@🐍3.9@macos-13
- GitHub Check: 🧪 Tests / pytest@🐍3.13@macos-13
- GitHub Check: 🧪 Tests / pytest@🐍3.11@windows-2025
🔇 Additional comments (1)
README.md (1)
215-228: Re-added dependencies block is correctly preservedThe detailed list of dependencies and their usage has been reinserted identically, resolving the previous duplication without altering content.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~218-~218: Loose punctuation mark.
Context: ...ommit](https://pre-commit.com/#install), <sub><sup>[terraform`](https://www.t...(UNLIKELY_OPENING_PUNCTUATION)
Co-authored-by: George L. Yermulnik <yz@yz.kiev.ua>
|
This PR is included in version 1.99.1 🎉 |
Description of your changes
git init/git cloneafter setting up ofinit.templateDir, which is not the case for 90%+ of newcomers.