Skip to content

docs: Add AGENTS.md#3461

Merged
ReneWerner87 merged 1 commit intov2from
v2-agents
May 19, 2025
Merged

docs: Add AGENTS.md#3461
ReneWerner87 merged 1 commit intov2from
v2-agents

Conversation

@gaby
Copy link
Member

@gaby gaby commented May 19, 2025

  • Backport AGENTS.md to v2.

@gaby gaby requested a review from a team as a code owner May 19, 2025 09:22
@gaby gaby requested review from ReneWerner87, efectn and sixcolors May 19, 2025 09:22
@gaby gaby added the v2 label May 19, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 19, 2025 •
edited
Loading

Walkthrough

A new documentation file, AGENTS.md, has been introduced. This file provides step-by-step instructions for setting up the development environment, including commands to install dependencies and essential CLI tools, as well as cleaning up Go module files. No code or public API changes are involved.

Changes

File(s) Change Summary
AGENTS.md Added new documentation with a startup script for environment setup and tool installation guidance.

Possibly related PRs

Suggested labels

📒 Documentation

Poem

A doc appears, so crisp and neat,
With setup steps and tools to greet.
No code to break, no tests to run,
Just guidance clear for everyone.
🐇✨
Now agents start without a hitch—
Thanks to docs, our work is rich!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot]
coderabbitai bot reviewed May 19, 2025
View reviewed changes
Copy link
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 (3)
AGENTS.md (3)

1-4: Remove .md extension from the header
The H1 title should reflect the document’s subject without including the file extension.

Apply this diff:

-# AGENTS.md
+# AGENTS

5-10: Use go mod download instead of go get ./...
go get ./... can inadvertently upgrade or add dependencies. For simply downloading existing modules, prefer go mod download.

Proposed change:

-  ```bash
-  go get ./...
-  ```
+    ```bash
+    go mod download
+    ```

11-21: Pin CLI tool versions for reproducible installs
Relying on @latest may lead to drifting tool versions. Specify explicit, tested versions to ensure consistency across environments.

Example for one tool:

-  go install gotest.tools/gotestsum@latest                 # test runner
+  go install gotest.tools/gotestsum@v1.13.0               # test runner (pinned)

Repeat version pinning for the other tools as appropriate.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 94e30d7 and 68460a6.

📒 Files selected for processing (1)
  • AGENTS.md (1 hunks)

@ReneWerner87 ReneWerner87 merged commit 7db10b6 into v2 May 19, 2025
2 checks passed
@ReneWerner87 ReneWerner87 added this to the Next Release milestone May 22, 2025
This was referenced May 24, 2025
Merged
Merged
@gaby gaby deleted the v2-agents branch June 18, 2025 02:08
@coderabbitai coderabbitai bot mentioned this pull request Aug 23, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 26, 2025
Merged
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

@sixcolors sixcolors Awaiting requested review from sixcolors sixcolors is a code owner automatically assigned from gofiber/maintainers

@ReneWerner87 ReneWerner87 Awaiting requested review from ReneWerner87 ReneWerner87 is a code owner automatically assigned from gofiber/maintainers

@efectn efectn Awaiting requested review from efectn efectn is a code owner automatically assigned from gofiber/maintainers

Assignees

No one assigned

Labels

📒 Documentation v2

Projects

None yet

Milestone

v2.52.8

Development

Successfully merging this pull request may close these issues.

2 participants

@gaby @ReneWerner87