README improvements #72
Conversation
WalkthroughThe changes in this pull request involve updates to the Changes
Possibly related issues
Possibly related PRs
Suggested reviewers
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
|
Hey @zleypner please can you update the PR description in the summary and set the issue this PR is going to close? |
README.md
Outdated
| @@ -48,7 +48,7 @@ curl -L https://install.dojoengine.org | bash | |||
| ``` | |||
| ### Install the latest Dojo release 🚀 | |||
There was a problem hiding this comment.
Can you update this to be accurate with the Dojo version we use in this project?
There was a problem hiding this comment.
this will be something like:
### Install the Dojo v1.0.0-alpha.5 release 🚀
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (5)
CONTRIBUTION.md (3)
1-18: Great addition of logo and social media badges!The inclusion of the ByteBeasts logo with dark/light mode support and social media badges enhances the project's branding and visibility. The X (Twitter) link has been correctly updated to the ByteBeasts account.
To improve accessibility, please add alt text to the social media badge images:
<a href="https://x.com/0xByteBeasts"> -<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social"/> +<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social" alt="Follow ByteBeasts on X"/> </a> <a href="https://x.com/0xByteBeasts"> -<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/> +<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social" alt="ByteBuildersLabs GitHub Stars"/> </a>🧰 Tools
🪛 Markdownlint
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
41-52: Approved: Clear instructions for branch creation and making changesThe instructions for creating a new branch and making changes are clear and provide good guidance on branch naming conventions.
Consider adding a comma after "feature or bug fix" for improved readability:
-Create a new branch for your feature or bug fix following the branch naming convention: +Create a new branch for your feature or bug fix, following the branch naming convention:🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
30-30: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
30-30: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
75-92: Approved: Clear instructions for submitting contributionsThe instructions for committing changes, pushing to fork, and submitting a Pull Request are clear and comprehensive. The addition of specific points to ensure in the PR submission is particularly helpful for contributors.
Consider reducing the number of exclamation marks in the conclusion for a more professional tone:
-Thank you for your contribution, and we look forward to collaborating with you!!! +Thank you for your contribution, and we look forward to collaborating with you!🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1656 characters long)
Context: ...e look forward to collaborating with you!!!(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
README.md (2)
20-23: Consider moving the style block to the bottom of the file.While the added CSS improves the visual presentation, it's unconventional to place a style block at the top of a markdown file. Consider moving it to the bottom to maintain better readability of the content.
Suggestion: Move the style block to the end of the file, just before the closing ``` of the code block.
11-11: Add alt text to GitHub stars shield for accessibility.To improve accessibility, please add alt text to the GitHub stars shield image.
Suggestion:
-<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/> +<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social" alt="GitHub stars"/>🧰 Tools
🪛 Markdownlint
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
assets/bytebeastslogo.svgis excluded by!**/*.svg
📒 Files selected for processing (2)
- CONTRIBUTION.md (3 hunks)
- README.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint
CONTRIBUTION.md
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
README.md
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
🪛 LanguageTool
CONTRIBUTION.md
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1656 characters long)
Context: ...e look forward to collaborating with you!!!(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (10)
CONTRIBUTION.md (5)
15-18: Excellent addition of the Telegram badge!The Telegram badge provides an easy way for contributors to join the project's chat. The implementation using a custom endpoint for the badge is a good practice.
21-23: Approved: CSS style additionThe added CSS style improves the visual layout of the document by adjusting the top margin of h1 elements.
Line range hint
24-40: Approved: Clear instructions for contributionThe introduction and initial steps provide clear guidance for contributors on how to fork and clone the repository. The structure and content are well-organized and easy to follow.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
30-30: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
30-30: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
53-74: Excellent addition of testing and deployment instructionsThe new instructions for running Katana, building the project, running tests, and applying migrations provide clear steps for setting up the development environment and ensuring comprehensive testing. This aligns well with the PR objectives and will help contributors ensure their changes are properly tested before submission.
Line range hint
1-92: Overall excellent improvements to the contribution guidelinesThe changes made to the CONTRIBUTION.md file significantly enhance its clarity, structure, and completeness. The additions of the project logo, social media badges, and detailed instructions for setting up the development environment and submitting contributions align well with the PR objectives. These improvements will greatly assist new contributors in understanding the project and the contribution process.
🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1656 characters long)
Context: ...e look forward to collaborating with you!!!(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint
51-51: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
README.md (5)
3-4: LGTM: Logo update and image optimization.The logo has been successfully updated to reflect ByteBeasts branding. The addition of lazy loading and styling attributes enhances performance and presentation. The alt text has been appropriately updated to "ByteBeats official logo".
18-18: LGTM: Telegram link update.The Telegram link has been successfully updated to the new URL.
58-58: LGTM: Dojoup version specified.The dojoup installation command has been updated to specify the exact version (v1.0.0-alpha.5), which aligns with the version defined in the
scarb.tomlfile as mentioned in the PR objectives. This addresses the previous review comment and provides clarity for contributors.
117-117: LGTM: Communication channel section added.The new communication channel section with the Telegram link is a valuable addition. It provides contributors with a clear way to connect with project maintainers and aligns with the updated Telegram link earlier in the file.
Line range hint
1-117: Overall, the README updates look great!The changes successfully address the PR objectives by updating branding, specifying the Dojo version, and improving communication channels. A few minor issues were identified:
- The GitHub link needs to be corrected.
- The style block could be moved to improve readability.
- Alt text should be added to the GitHub stars shield.
Once these small adjustments are made, the README will be significantly improved and ready for merging.
🧰 Tools
🪛 Markdownlint
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CONTRIBUTION.md (2)
1-18: Great addition of logo and social media badges!The inclusion of the ByteBeasts logo with dark/light mode support and social media badges enhances the project's branding and visibility. The X (Twitter) link has been correctly updated as requested in the previous review.
To improve accessibility, please add alt text to the social media badge images. Apply this diff:
<a href="https://x.com/0xByteBeasts"> -<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social"/> +<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social" alt="Follow on X (Twitter)"/> </a> <a href="https://x.com/0xByteBeasts"> -<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/> +<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social" alt="GitHub Stars"/> </a>🧰 Tools
🪛 Markdownlint
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
41-52: LGTM: Clear instructions for branch creation and making changesThe instructions for creating a new branch and making changes are clear and provide good guidance for contributors.
Consider adding a comma after "feature or bug fix" for improved readability:
-Create a new branch for your feature or bug fix following the branch naming convention: +Create a new branch for your feature or bug fix, following the branch naming convention:🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
30-30: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
30-30: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- CONTRIBUTION.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint
CONTRIBUTION.md
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
🪛 LanguageTool
CONTRIBUTION.md
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1655 characters long)
Context: ...e look forward to collaborating with you!(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (6)
CONTRIBUTION.md (6)
15-18: LGTM: Telegram badge additionThe Telegram badge is a great addition, providing an easy way for contributors to join the project's communication channel. The implementation is correct and consistent with the other badges.
21-23: LGTM: CSS style additionThe added CSS style for h1 elements improves the visual layout of the document.
Line range hint
24-40: LGTM: Clear introduction and initial stepsThe introduction and initial steps provide clear instructions for contributors on how to fork and clone the repository. The content is well-structured and easy to follow.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...te a new branch for your feature or bug fix following the branch naming convention:...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
30-30: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
30-30: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
33-33: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
53-74: Excellent addition of testing and deployment instructionsThe new instructions for running Katana, building, testing, and applying migrations provide clear and comprehensive steps for contributors to test their changes. This addition will help ensure that all contributions are properly tested before submission.
75-92: LGTM: Clear final steps and positive conclusionThe instructions for committing changes, pushing to fork, and submitting a pull request are clear and comprehensive. The conclusion is positive, welcoming, and encourages collaboration.
🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1655 characters long)
Context: ...e look forward to collaborating with you!(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Line range hint
1-92: Overall excellent improvements to the contribution guidelinesThe updates to the CONTRIBUTION.md file significantly enhance its clarity, usability, and visual appeal. The addition of the logo, social media badges, and clear instructions for the entire contribution process will greatly benefit new contributors. The inclusion of specific steps for running Katana, building, testing, and applying migrations is particularly valuable.
A few minor suggestions have been made to further improve accessibility and readability. Great work on these updates!
🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1655 characters long)
Context: ...e look forward to collaborating with you!(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint
51-51: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
75-75: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
82-82: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Update to dojo version
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
README.md (1)
20-24: Consider alternative styling approach.Adding CSS directly in the markdown file may not be supported or rendered correctly on all platforms. Consider using markdown-native approaches or platform-specific styling options if available.
For example, you could add extra newlines before h1 elements or use a horizontal rule:
--- # Byte Beasts: Official Guide 🐉🎮If custom styling is necessary, consider documenting this requirement for proper rendering of the README.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
🔇 Additional comments (5)
README.md (5)
3-4: LGTM: Logo update and styling improvements.The changes to the logo image, including the update to ByteBeasts, addition of lazy loading, and improved styling, enhance both branding and performance. The alt text has been appropriately updated as well.
18-18: LGTM: Telegram link update.The Telegram link has been successfully updated to the new URL, which aligns with the PR objectives.
56-56: LGTM: Dojo version specification.The Dojo installation command has been correctly updated to specify version v1.0.0-alpha.5, addressing the past review comment and aligning with the PR objectives.
114-114: LGTM: Communication channel addition.The new section for the communication channel, including the Telegram group link, is a valuable addition. It promotes community engagement and aligns with good open-source practices.
7-11:⚠️ Potential issueCorrect GitHub link and add alt text to images.
- The Twitter link and shield have been correctly updated to @0xByteBeasts.
- The GitHub link on line 10 needs to be corrected:
-<a href="https://x.com/0xByteBeasts"> +<a href="https://github.com/ByteBuildersLabs">
- Add alt text to the shield images to improve accessibility:
-<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social"/> +<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social"/> -<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/> +<img alt="GitHub Stars" src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/>🧰 Tools
🪛 Markdownlint
8-8: null
Images should have alternate text (alt text)(MD045, no-alt-text)
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Pull Request Overview
Updated Testing Section in Contribution Guidelines
Closes #72
🔄 Changes Made
Version Specification in README:
Specified the exact version of dojo required to run the project, based on the version defined in the scarb.toml file.
Stats and Branding Update:
Replaced the default stats with project's statistics.
Added The logo next to the Dojo logo for better branding and visual consistency.
Summary by CodeRabbit
New Features
CONTRIBUTION.mdwith visual elements and social media links for improved presentation.Documentation
README.mdto specify the version for thedojoupinstallation command.Summary by CodeRabbit
New Features
CONTRIBUTION.mdwith improved clarity and new instructions for development processes.README.mdwith the ByteBeats logo and new social media links.Bug Fixes
Documentation
dojoupto versionv1.0.0-alpha.5.README.md.