Fix Spelling and Grammar Issues in Tutorial Suggestion Template #1101
Conversation
Short Description of Changes: - Corrected grammatical errors in descriptions. - Fixed spelling of "copyrighted". - Corrected possessive form from "someones" to "someone's".
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request introduces textual corrections and clarifications to two GitHub issue templates: "Suggest a glossary term" and "Suggest a tutorial." Changes include grammatical improvements and adjustments for clarity in field descriptions and labels. Specifically, phrases were modified for better understanding, and spelling errors were corrected. These alterations do not affect the functionality or structure of the templates. Changes
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
Documentation and Community
|
![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
🧹 Outside diff range and nitpick comments (1)
.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml (1)
50-50: LGTM! Consider additional clarity improvements.The change from "someones" to "someone's" correctly fixes the possessive form.
Consider rephrasing to be more direct:
- description: If appropriate/available, please suggest an internal optimism.io link that would expand someone's learning of this term + description: If available, suggest an internal optimism.io link that helps explain this term in more detail
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml(2 hunks).github/ISSUE_TEMPLATE/suggest_tutorial.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/suggest_tutorial.yaml
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml (2)
21-21: LGTM! Grammar improvement enhances clarity.
The change from "or contain" to "and does not contain" improves parallelism and makes the requirement more explicit.
42-42: LGTM! Correct spelling of legal term.
The change from "copywrited" to "copyrighted" fixes the spelling and uses the proper legal terminology.
Short Description of Changes: