Skip to content

Feat: Create AGENTS.md#10993

Merged
Meldiron merged 2 commits into1.8.xfrom
feat-agents-md
Dec 19, 2025
Merged

Feat: Create AGENTS.md#10993
Meldiron merged 2 commits into1.8.xfrom
feat-agents-md

Conversation

@Meldiron
Copy link
Copy Markdown
Contributor

@Meldiron Meldiron commented Dec 19, 2025 •
edited
Loading

What does this PR do?

Instructs AI to generate best possible code.

Test Plan

As we use it, we will find out

Related PRs and Issues

x

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 Dec 19, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

A new AGENTS.md documentation file is added that provides guidelines and reference material for AI coding agents working on the codebase. It includes project context, development setup commands, code style and naming conventions (including resourceType pluralization), security practices, dependency policy, pull request guidelines, and a list of known issues. The file contains example commands and structured sections for agent workflows and developer guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Documentation addition only — no code or behavioral changes to review
  • Self-contained file with guidance and examples; verify clarity and consistency with existing project practices
  • Areas to spot-check:
    • Naming convention examples (resourceType pluralization) for consistency with actual codebase
    • Security and dependency policy wording for alignment with repository standards

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Feat: Create AGENTS.md' directly and clearly summarizes the primary change: adding a new AGENTS.md file to the repository.
Description check ✅ Passed The description explains the purpose of the change ('Instructs AI to generate best possible code') which is related to the AGENTS.md file being added, though it lacks implementation details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat-agents-md
📜 Recent 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 1b1ef80 and ee7103c.

📒 Files selected for processing (1)
  • AGENTS.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • AGENTS.md
⏰ 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). (1)
  • GitHub Check: scan

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.

coderabbitai[bot]
coderabbitai bot reviewed Dec 19, 2025
View reviewed changes
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: 1

📜 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 06e3a14 and 1b1ef80.

📒 Files selected for processing (1)
  • AGENTS.md (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)
AGENTS.md (1)

61-68: Clarify or remove stray file path at line 68.

Line 68 contains a bare file path `docs/specs/authentication.drawio.svg` which appears to be either accidentally included or improperly formatted. It breaks the list structure of the PR Guidelines section and its intent is unclear.

Please clarify whether this is intentional content (e.g., a link to documentation that should be referenced?) or should be removed entirely.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 19, 2025 •
edited
Loading

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
libpng 1.6.51-r0 CVE-2025-66293 HIGH
libpng-dev 1.6.51-r0 CVE-2025-66293 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 19, 2025

✨ Benchmark results

  • Requests per second: 1,166
  • Requests with 200 status code: 209,887
  • P99 latency: 0.167419183

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 1,166 1,213
200 209,887 218,384
P99 0.167419183 0.170802968

@Meldiron Meldiron merged commit a20392d into 1.8.x Dec 19, 2025
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@eldadfux eldadfux eldadfux approved these changes

@loks0n loks0n loks0n approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Meldiron @eldadfux @loks0n