Skip to content

feat: Add new tips to Comment class#10771

Merged
Meldiron merged 1 commit into1.8.xfrom
Update-facts-on-Github-sites-and-functions
Nov 6, 2025
Merged

feat: Add new tips to Comment class#10771
Meldiron merged 1 commit into1.8.xfrom
Update-facts-on-Github-sites-and-functions

Conversation

@HarshMN2345
Copy link
Copy Markdown
Member

What does this PR do?

(Provide a description of what this PR does and why it's needed.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)

Related PRs and Issues

  • (Related PR or issue)

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Nov 6, 2025

📝 Walkthrough

Walkthrough

The $tips array in src/Appwrite/Vcs/Comment.php was expanded, replacing the existing three tips with a significantly larger collection of new tips. The array remains used for random tip selection during execution. No method signatures, class structures, or control flow logic were modified—only the content of the data array changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • The change is purely data-driven with no logic modifications
  • Single file affected with homogeneous, repetitive content updates
  • Random selection mechanism remains unchanged and requires no functional verification

Possibly related PRs

Suggested reviewers

  • Meldiron

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Description check ❓ Inconclusive The description contains only the default contribution template with empty sections and no specific details about the changes, making it completely uninformative about the actual changeset. Fill in the template sections with concrete details: what the new tips are, why they were added, how to test the changes, and confirm the contribution checklist items.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: Add new tips to Comment class' directly and clearly describes the main change: adding new tips to the Comment class, which matches the changeset perfectly.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Update-facts-on-Github-sites-and-functions

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 6, 2025

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.44-r2 CVE-2025-5244 HIGH
binutils 2.44-r2 CVE-2025-5245 HIGH
libxml2 2.13.8-r0 CVE-2025-49794 CRITICAL
libxml2 2.13.8-r0 CVE-2025-49796 CRITICAL
libxml2 2.13.8-r0 CVE-2025-49795 HIGH
libxml2 2.13.8-r0 CVE-2025-6021 HIGH
pcre2 10.43-r1 CVE-2025-58050 CRITICAL
golang.org/x/crypto v0.31.0 CVE-2025-22869 HIGH
golang.org/x/oauth2 v0.24.0 CVE-2025-22868 HIGH
stdlib 1.22.10 CVE-2025-47907 HIGH
stdlib 1.22.10 CVE-2025-47912 HIGH
stdlib 1.22.10 CVE-2025-58183 HIGH
stdlib 1.22.10 CVE-2025-58186 HIGH
stdlib 1.22.10 CVE-2025-58187 HIGH
stdlib 1.22.10 CVE-2025-58188 HIGH
stdlib 1.22.10 CVE-2025-61724 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Appwrite/Vcs/Comment.php (1)

12-12: Consider updating or removing the TODO comment.

This PR significantly expands the tips collection from 3 to 31 items. Consider whether the TODO should be removed (if the collection is now sufficient) or updated to reflect that this is complete for now.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68ae8ce and 9b52f6f.

📒 Files selected for processing (1)
  • src/Appwrite/Vcs/Comment.php (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: scan
🔇 Additional comments (1)
src/Appwrite/Vcs/Comment.php (1)

14-15: Hardcoded metrics in tips will require updates as project grows.

Lines 14-15 contain specific metrics ("50K GitHub stars", "24K developers") that are displayed to users in GitHub PR comments. These will become outdated as Appwrite's community grows, and line 20's "15 minutes" timeout may also require updates if platform limits change.

Since these tips are randomly selected and shown each time generateComment() is called, consider whether to:

  • Replace metrics with evergreen phrasing (e.g., "Appwrite has a thriving community with thousands of active contributors")
  • Extract these values into a simple constants file for easier periodic updates
  • Document when these values should be reviewed and updated

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 6, 2025

✨ Benchmark results

  • Requests per second: 1,186
  • Requests with 200 status code: 213,531
  • P99 latency: 0.163934571

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 1,186 1,185
200 213,531 213,274
P99 0.163934571 0.176913561

@Meldiron Meldiron merged commit e342009 into 1.8.x Nov 6, 2025
43 checks passed
@HarshMN2345 HarshMN2345 deleted the Update-facts-on-Github-sites-and-functions branch November 6, 2025 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants