docs : Update Readme.md #3564
docs : Update Readme.md #3564
Conversation
Divendra2006
requested review from
quetzalliwrites,
derberg,
akshatnema,
magicmatatjahu,
Mayaleeeee and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request introduces updated cloning instructions in the README.md file, providing users with two distinct methods for repository cloning: a shallow clone for minimizing downloaded data and a traditional full clone. This enhancement offers more flexibility for developers when setting up the project, catering to different bandwidth and storage preferences. Changes
Poem
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
Documentation and Community
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
We require all PRs to follow Conventional Commits specification. |
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3564 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
![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 (3)
README.md (3)
49-50: Enhance the introduction to cloning options.Consider adding brief explanations about when to use each option. For example:
-Depending on your case , you can choose one of the following options: +Depending on your needs, you can choose one of the following options: + +- Use Option 1 (shallow clone) for faster downloads and minimal disk usage +- Use Option 2 (full clone) when you need the complete repository history
51-55: Improve the shallow clone section formatting and clarity.
- Fix the title formatting and grammar
- Add a note about the placeholder
-### **Option 1: Clone Only Latest Commit (shallow Clone)** +### **Option 1: Clone Only the Latest Commit (Shallow Clone)** ```bash - git clone --depth 1 https://github.com/<username>/website/ + git clone --depth 1 https://github.com/<username>/website/
+Note: Replace
<username>with your GitHub username.<details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~51-~51: You might be missing the article “the” here. Context: ...ng options: ### **Option 1: Clone Only Latest Commit (shallow Clone)** ```bash g... (AI_EN_LECTOR_MISSING_DETERMINER_THE) </details> </details> --- `56-57`: **Make the full clone section consistent with Option 1.** Add more context and maintain consistent formatting: ```diff ### **Option 2: Clone the full Repository** + +```bash + git clone https://github.com/<username>/website/ +``` + +Note: Replace `<username>` with your GitHub username.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~51-~51: You might be missing the article “the” here.
Context: ...ng options: ### Option 1: Clone Only Latest Commit (shallow Clone) ```bash g...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 180000ms (1)
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
README.md (1)
49-57: LGTM! Good addition of cloning options.The changes effectively introduce two cloning methods, giving users flexibility in how they interact with the repository. The suggested refinements above would further enhance the clarity and consistency of the documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: You might be missing the article “the” here.
Context: ...ng options: ### Option 1: Clone Only Latest Commit (shallow Clone) ```bash g...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3564--asyncapi-website.netlify.app/ |
Description
Related issue(s)
Summary by CodeRabbit