Add issue number prompt in pull_request_template.md

[ChinoUkaegbu]

✨ Codu Pull Request 💻

Related to #1018

Pull Request details

Adds issue number to PR template so contributors can link related issues in PRs

Any Breaking changes

None

Associated Screenshots

None

[vercel]

@ChinoUkaegbu is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The pull request introduces a modification to the .github/pull_request_template.md file by adding a prompt for users to specify an issue number that the pull request addresses. This change aims to improve the linkage between pull requests and their corresponding issues, enhancing the clarity and traceability of the contributions made.

Changes

File	Change Summary
.github/pull_request_template.md	Added a line prompting users to specify an issue number (e.g., Fixes #1012).

Possibly related PRs

• Remove codu logo in pull_request_template.md #1018: This PR also modifies the .github/pull_request_template.md file, indicating a direct connection to the changes made in the main PR.

Poem

🐰 In the garden of code, we plant a new seed,
A line for the issues, a helpful new deed.
With each pull request, we link and align,
Fixes and issues, all perfectly fine!
Hops of joy as we trace every change,
Together we build, in this coding range! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7d95eb9 and a847c1a.

Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

Additional comments not posted (1)

.github/pull_request_template.md (1)

3-4: LGTM!

The addition of the prompt to specify the related issue number aligns perfectly with the PR objective. The example comment provides clear guidance on how to format the issue reference. This change will improve the clarity and context of pull requests by encouraging contributors to link them to specific issues.

---

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?

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 resolve resolve all the CodeRabbit review comments.
• @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.

[NiallJoeMaher]

🌮 LGTM!

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
codu	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 11:17am

[John-Paul-Larkin]

Thanks ChinoUkaegbu