Update README.md #93
Update README.md #93
Conversation
WalkthroughThe README.md file was updated to include a detailed "Contribution Guidelines" section, providing step-by-step instructions and best practices for contributing, submitting video demonstrations, and reporting issues. The previous brief note on contributing was replaced, and the closing encouragement was revised to reflect the expanded guidance. Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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
CodeRabbit Configuration File (
|
![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 (7)
README.md (7)
128-128: Fix Markdown heading spacing
There are two spaces between the##and the heading text. Markdown ATX style requires a single space.
Diff:-## Contribution Guidelines +## Contribution Guidelines🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
128-128: Multiple spaces after hash on atx style heading
null(MD019, no-multiple-space-atx)
132-132: Fix Markdown heading spacing
Remove extra spaces after the ATX marker:-### How to Contribute +### How to Contribute🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
132-132: Multiple spaces after hash on atx style heading
null(MD019, no-multiple-space-atx)
166-166: Fix Markdown heading spacing
Normalize to a single space after the ATX marker:-### Best Practices +### Best Practices🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
166-166: Multiple spaces after hash on atx style heading
null(MD019, no-multiple-space-atx)
175-175: Fix Markdown heading spacing
Remove the extra space after###:-### Submitting a Video Demonstration +### Submitting a Video Demonstration🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
175-175: Multiple spaces after hash on atx style heading
null(MD019, no-multiple-space-atx)
183-183: Fix Markdown heading spacing
Use a single space after the ATX marker for consistency:-### Reporting Issues +### Reporting Issues🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
183-183: Multiple spaces after hash on atx style heading
null(MD019, no-multiple-space-atx)
130-131: Optional: Refine the welcome message
Consider rephrasing to make it more concise and engaging. For example:-Thank you for your interest in contributing to **DebateAI**! We appreciate your efforts in making this project better. Please follow these best practices to ensure smooth collaboration. +Thank you for your interest in contributing to **DebateAI**! Your contributions help us improve the platform. Please review these guidelines to streamline collaboration.🧰 Tools
🪛 LanguageTool
[style] ~130-~130: The wording of this phrase can be improved.
Context: ...bateAI**! We appreciate your efforts in making this project better. Please follow these best practices to ...(MAKE_STYLE_BETTER)
2-2: Optional: Host the logo asset locally
Linking to an external thumbnail may lead to broken images or CORS issues. Consider storing the logo underassets/and referencing it relative to the repo:-<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRpPlI1P7SK3pemg67VMPbvNzxYyk0UtlmJiQ&s" alt="Aossie Logo" height="120"/> +<img src="assets/logo.png" alt="Aossie Logo" height="120"/>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~130-~130: The wording of this phrase can be improved.
Context: ...bateAI**! We appreciate your efforts in making this project better. Please follow these best practices to ...
(MAKE_STYLE_BETTER)
[uncategorized] ~136-~136: Consider adding a hyphen.
Context: ...AI). - Click the Fork button in the top right corner. - Clone the forked repository t...
(TOP_LEFT_CORNER)
🪛 markdownlint-cli2 (0.17.2)
README.md
128-128: Multiple spaces after hash on atx style heading
null
(MD019, no-multiple-space-atx)
132-132: Multiple spaces after hash on atx style heading
null
(MD019, no-multiple-space-atx)
166-166: Multiple spaces after hash on atx style heading
null
(MD019, no-multiple-space-atx)
175-175: Multiple spaces after hash on atx style heading
null
(MD019, no-multiple-space-atx)
183-183: Multiple spaces after hash on atx style heading
null
(MD019, no-multiple-space-atx)
2 participants
Summary by CodeRabbit