ci: improve pull request template

[killme2008]

What's Changed in this PR

Describe the change in this PR

Add notes for pull requests.

Checklist

• Please ensure that the content in summary.yml matches the current document structure when you changed the document structure.
• This change requires follow-up update in localized docs.

Summary by CodeRabbit

• Documentation
  • Updated the pull request template to include a new section for confirming the revision of document versions for GreptimeDB compatibility.

[coderabbitai]

Walkthrough

The PR template has been updated to include a section for confirming the revision of corresponding document versions for GreptimeDB compatibility. This ensures that any related documentation is kept up-to-date in sync with the code changes.

Changes

Files	Change Summary
.github/.../pull_request_template.md	Added a new section for confirming the revision of corresponding document versions for GreptimeDB compatibility.

🐇
In fields of code where updates flow,
A checklist grows, ensures we know,
Documentation’s up-to-date,
With GreptimeDB, we coordinate!
Let changes bloom, both near and far,
In harmony, like a guiding star.
🌟

Warning

Review ran into problems

Problems (1)

• Git: Failed to clone repository. Please contact CodeRabbit support.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d572891 and 101ab3f.

Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/pull_request_template.md

[cloudflare-workers-and-pages]

Deploying greptime-docs with    Cloudflare Pages

Latest commit:	101ab3f
Status:	✅  Deploy successful!
Preview URL:	https://5775d693.greptime-docs.pages.dev
Branch Preview URL:	https://feature-tweak-pr-template.greptime-docs.pages.dev

View logs