docs: task link for PR templates

[kshitij-k-osmosys]

Portal PR Checklist

Task Link

Osmosys Developers must include the Pinestem task link in the PR.

REST-1237

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary testing to ensure that any existing features are not impacted and any new features are working as expected.

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login page)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

Add task link for API and Portal PR templates

Summary by CodeRabbit

• Documentation
  • Updated pull request guidelines by adding a "Task Link" section, requiring developers to attach a direct link to the related task using the designated format, which enhances clarity and traceability during reviews.

[coderabbitai]

Walkthrough

This update adds a new "Task Link" section to two pull request templates. The new section requires developers to include a link to the relevant Pinestem task in the format [REST-###](pinestem-task-url). The change applies to both API and portal templates to ensure proper task traceability in PR submissions.

Changes

File(s)	Change Summary
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md .github/PULL_REQUEST_TEMPLATE/pull_request_template_portal.md	Added a new "Task Link" section requiring a Pinestem task link in the format [REST-###](pinestem-task-url)

Suggested reviewers

• osm-vishnukyatannawar
• xixas

Poem

Hop along, dear devs, with a skip and a cheer,
A new task link section has hopped into here,
Mark your pull requests with the link so neat,
Like carrots in a garden — a trace that's sweet,
From a rabbit with joy, may your commits be clear!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a860074 and 99a5461.

📒 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 comments (2)

.github/PULL_REQUEST_TEMPLATE/pull_request_template_portal.md (1)

3-7: Consistent and Clear Task Link Section

The new "Task Link" section is concise and clearly instructs developers to include the mandatory Pinestem task link. The placeholder [REST-###](pinestem-task-url) is appropriate for guiding developers on the expected format.

.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (1)

3-7: Uniform Task Link Addition for API Template

The addition of the "Task Link" section in the API template mirrors the portal template, ensuring consistency across PR checklists. The instruction is clear, and using the placeholder format helps maintain a standardized approach.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.