docs: task link for PR template #399
Conversation
WalkthroughThe pull request introduces a new mandatory section titled Task Link in two pull request templates. This section, inserted above the "Pre-requisites" section, includes a placeholder formatted as Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
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 (
|
kshitij-k-osmosys
added
documentation
![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 (2)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (1)
3-6: Nitpick: Fix duplicate word and adjust markdown link formattingThere's a duplicate "for" in the link description on line 5. To ensure clear communication and proper markdown formatting, please update the line so it reads:
[OSXT-###](pinestem-task-url). Mandatory to add for Osmosys Developers
This ensures the link is correctly formatted and the message is clear.-[OSXT-###](pinestem-task-url. Mandatory to add for for Osmosys Developers) +[OSXT-###](pinestem-task-url). Mandatory to add for Osmosys Developers🧰 Tools
🪛 LanguageTool
[duplication] ~5-~5: Possible typo: you repeated a word.
Context: ...##](pinestem-task-url. Mandatory to add for for Osmosys Developers) ### Pre-requisites...(ENGLISH_WORD_REPEAT_RULE)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_portal.md (1)
3-6: Nitpick: Remove duplicate word in Task Link sectionSimilar to the API template, the Portal template has a duplicated "for" in the Task Link description on line 5. Please update this line to ensure consistency and clarity:
-[OSXT-###](pinestem-task-url. Mandatory to add for for Osmosys Developers) +[OSXT-###](pinestem-task-url). Mandatory to add for Osmosys Developers🧰 Tools
🪛 LanguageTool
[duplication] ~5-~5: Possible typo: you repeated a word.
Context: ...##](pinestem-task-url. Mandatory to add for for Osmosys Developers) ### Pre-requisites...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md(1 hunks).github/PULL_REQUEST_TEMPLATE/pull_request_template_portal.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE/pull_request_template_portal.md
[duplication] ~5-~5: Possible typo: you repeated a word.
Context: ...##](pinestem-task-url. Mandatory to add for for Osmosys Developers) ### Pre-requisites...
(ENGLISH_WORD_REPEAT_RULE)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md
[duplication] ~5-~5: Possible typo: you repeated a word.
Context: ...##](pinestem-task-url. Mandatory to add for for Osmosys Developers) ### Pre-requisites...
(ENGLISH_WORD_REPEAT_RULE)
API PR Checklist
Pre-requisites
.env.examplefile with the required values as applicable.PR Details
PR details have been updated as per the given format (see below)
feat: add admin login endpoint)Additional Information
ready for reviewshould be added if the PR is ready to be reviewed)Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.
Description:
Add task link for API and Portal PR templates
Summary by CodeRabbit