Update created & maintain by section #100
Conversation
WalkthroughThe changes made in the pull request focus on updating the Changes
Suggested reviewers
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
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: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
screenshots/cta_btn.pngis excluded by!**/*.png
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
Markdownlint
README.md
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
README.md (1)
59-60: LGTM!The changes to the section title and content improve clarity and conciseness while maintaining the acknowledgment of the Canopas team.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
README.md (1)
59-62: Excellent addition of the "Feedback and Suggestions" section!The new section provides clear guidance on where to report issues and have discussions. The GitHub Issues link is correctly formatted.
To improve readability, consider adding a comma after "For bugs" as suggested by the static analysis tool:
-For bugs, questions and discussions please use +For bugs, questions, and discussions, please useTools
LanguageTool
[typographical] ~61-~61: Consider adding a comma here.
Context: ...ons For bugs, questions and discussions please use the [Github Issues](https://github....(PLEASE_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[typographical] ~61-~61: Consider adding a comma here.
Context: ...ons For bugs, questions and discussions please use the [Github Issues](https://github....(PLEASE_COMMA)
Markdownlint
README.md
68-68: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (2)
README.md (2)
65-66: LGTM!The new "Credits" section provides clear attribution to the Canopas team for their ownership and maintenance of the project. The Canopas website link and Twitter handle are correctly formatted.
68-68: Verify the image source update.Please ensure that the call-to-action button image file has been moved from
./cta/cta_btn.pngto./screenshots/cta_btn.png. If not, please update the image source accordingly.Add alternate text for the image.
As mentioned in the previous review comment and flagged by the static analysis tool, please add alternate text (alt text) for the image to improve accessibility.
Apply this diff to add alternate text:
-<a href="https://canopas.com/contact"><img src="./screenshots/cta_btn.png" width=300></a> +<a href="https://canopas.com/contact"><img src="./screenshots/cta_btn.png" alt="Contact Canopas" width=300></a>Tools
Markdownlint
68-68: 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 (1)
README.md (1)
68-68: Consider removing the excessive exclamation marks.The use of 4 exclamation marks at the end of the segment might seem excessive and unprofessional. Please consider removing them to maintain a more professional tone.
Apply this diff to remove the excessive exclamation marks:
-You can follow them on Twitter at [@canopassoftware](https://twitter.com/canopassoftware) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!!!! +You can follow them on Twitter at [@canopassoftware](https://twitter.com/canopassoftware) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!Tools
LanguageTool
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2377 characters long)
Context: ... let us know. We'd love to hear from you! ...(EN_EXCESSIVE_EXCLAMATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2377 characters long)
Context: ... let us know. We'd love to hear from you! ...(EN_EXCESSIVE_EXCLAMATION)
Markdownlint
README.md
70-70: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (3)
README.md (3)
59-62: LGTM!The addition of a dedicated section for feedback and suggestions is a great way to encourage user engagement and improve the project based on user input. Linking to the GitHub Issues page is an effective approach to streamline the feedback process and keep all discussions in one place.
64-68: LGTM!The new "Credits" section is a great addition to acknowledge the Canopas team's efforts and contributions to the Khelo project. Including a link to the Canopas website provides users with additional information about the team behind the project.
Tools
LanguageTool
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2377 characters long)
Context: ... let us know. We'd love to hear from you! ...(EN_EXCESSIVE_EXCLAMATION)
70-70: Address the accessibility issue by adding alternate text for the image.The updated image source looks good. However, as mentioned in the previous review comment, please consider adding alternate text (alt text) for the image to improve accessibility.
Apply this diff to add alternate text:
-<a href="https://canopas.com/contact"><img src="./screenshots/cta_btn.png" width=300></a> +<a href="https://canopas.com/contact"><img src="./screenshots/cta_btn.png" alt="Contact Canopas" width=300></a>Tools
Markdownlint
70-70: 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 (1)
README.md (1)
61-64: Improve readability by adding a comma.The content of the "Feedback & Suggestions" section is well-written and effectively directs users to the appropriate channels for reporting bugs and engaging in discussions.
To enhance readability, consider adding a comma after "For bugs" as suggested by the static analysis tool.
Apply this diff to add the comma:
-For bugs, questions and discussions please use the [Github Issues](https://github.com/canopas/khelo/issues). +For bugs, questions, and discussions, please use the [Github Issues](https://github.com/canopas/khelo/issues).Tools
LanguageTool
[typographical] ~63-~63: Consider adding a comma here.
Context: ...nt. For bugs, questions and discussions please use the [Github Issues](https://github....(PLEASE_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
cta/cta_btn.pngis excluded by!**/*.png
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[typographical] ~63-~63: Consider adding a comma here.
Context: ...nt. For bugs, questions and discussions please use the [Github Issues](https://github....(PLEASE_COMMA)
Additional comments not posted (3)
README.md (3)
59-59: LGTM!The addition of the "Feedback & Suggestions" section is a great way to encourage user engagement and gather valuable insights for improving the project.
66-69: LGTM!The renaming of the section to "Credits" and the inclusion of the Canopas team's acknowledgment, website link, and Twitter handle for project updates is a great way to give credit to the project maintainers and provide users with relevant resources.
69-69: Move the call-to-action button image back to thectafolder.The change in the image source path indicates that the call-to-action button image has been moved from the
ctafolder to thescreenshotsfolder. However, this contradicts the suggestion made in the past review comment by cp-sidhdhi-p, which recommends adding the button to thectafolder instead of thescreenshotsfolder.To maintain a more organized and logical structure, consider moving the button image back to the
ctafolder, as it is a call-to-action asset rather than a screenshot.Apply this diff to revert the image source path:
-<a href="https://canopas.com/contact"><img src="./screenshots/cta_btn.png" width=300></a> +<a href="https://canopas.com/contact"><img src="./cta/cta_btn.png" width=300></a>
Summary by CodeRabbit