📒 docs: Update AGENTS.md

[gaby]

Summary

• add general coding practices covering parallelized tests, utils usage, and linting order
• document pull request title prefix requirements and emphasize full-change summaries

---

Codex Task

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

AGENTS.md is updated with two new editorial sections: "General coding practices" (Go test concurrency, utils usage, lint-before-test workflow, secure-by-default guidance) and "Pull request guidelines" (PR title category prefixes and required PR body Summary). No code or runtime behavior changes.

Changes

Cohort / File(s)

Summary

Documentation additions AGENTS.md

Adds "General coding practices" section (recommendations: use t.Parallel() in Go tests, prefer utils.Trim from github.com/gofiber/utils/v2, keep RFC-compliant protocol behavior, profile hot paths, secure-by-default choices) and "Pull request guidelines" section (PR title prefixes: 🐛 bug:, 🔥 feat:, 📒 docs:, 🧹 chore:; require a Summary section in PR body). Also inserts make lint into the documented programmatic checks sequence.

Sequence Diagram(s)

(omitted — changes are editorial/documentation-only and don't alter control flow)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Purely documentation edits with no code changes.

Possibly related PRs

• Update AGENTS startup instructions #3474 — edits to AGENTS.md and Makefile/workflow references; mentions lint target.
• docs: Add AGENTS.md #3461 — earlier expansion of AGENTS.md content; overlaps editorial scope.
• 📚 Doc: fix AGENTS markdown lint #3460 — formatting/markdown updates to AGENTS.md.

Suggested reviewers

• sixcolors
• ReneWerner87
• efectn

Poem

🐰 I hopped through lines of docs so new,
I fixed the notes and tidied the view,
Tests run parallel, lint first in line,
PRs titled tidy — the process feels fine! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is minimal and lacks most required template sections including changes introduced, type of change, and comprehensive checklist items.	Expand the description to include the 'Changes introduced' section with documentation update details, select appropriate 'Type of change' checkbox(es), and complete relevant checklist items from the template.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely identifies that this PR updates the AGENTS.md documentation file with the appropriate 📒 docs prefix.
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 update-agents.md-with-testing-guidelines

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[gemini-code-assist]

Summary of Changes

Hello @gaby, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the "AGENTS.md" documentation by incorporating new general coding practices for Go development and establishing clear guidelines for pull request submissions. The changes aim to standardize code quality, improve test efficiency, and ensure consistent and informative pull request descriptions across the project.

Highlights

• General Coding Practices: Introduced new guidelines for Go development, including always invoking "t.Parallel()" for tests, preferring "github.com/gofiber/utils/v2" helpers for common operations, and running "make lint" before "make test".
• Pull Request Guidelines: Added requirements for PR titles to include category prefixes (e.g., "bug:", "feat:", "docs:", "chore:") and emphasized that PR bodies should contain a comprehensive "Summary" section covering all changes.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request clarifies agent guidelines by adding sections on general coding practices and pull request conventions. The new guidelines are valuable additions. I've left a couple of comments to improve consistency within the document and with common development standards.

[Copilot]

Pull request overview

This PR enhances the AGENTS.md documentation by adding specific coding practices and pull request formatting requirements for AI agents working with the Fiber codebase.

• Adds general coding practices section covering test parallelization, utility package usage, and linting workflow
• Documents pull request title prefix requirements (bug:, feat:, docs:, chore:)
• Emphasizes that PR summaries should capture all changes, not just the latest commit

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40948a2 and c77617b.

📒 Files selected for processing (1)

• AGENTS.md (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.md

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Run make markdown to lint all Markdown files when modifying code

Files:

• AGENTS.md

🧠 Learnings (17)

📓 Common learnings

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Before presenting final changes or submitting a pull request, run audit, generate, betteralign, modernize, format, and test commands and ensure they all succeed, including their output in the final response

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Before presenting final changes or submitting a pull request, run audit, generate, betteralign, modernize, format, and test commands and ensure they all succeed, including their output in the final response

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Run `make modernize` to apply Go language modernization improvements

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:37.127Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-26T11:06:37.127Z
Learning: Run `make lint` for static analysis when modifying code

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Run `make lint` to execute golangci-lint for linting

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:37.127Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-26T11:06:37.127Z
Learning: Applies to **/*.md : Run `make markdown` to lint all Markdown files when modifying code

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to {go.mod,go.sum,Makefile} : Verify that all Go dependencies and CLI tools are available before running the startup script. Skip the startup script if a `vendor/` directory exists or `go list -m -mod=readonly all` succeeds

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to {go.mod,Makefile} : Fetch Go dependencies using `go mod tidy && go mod download && go mod vendor`

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to Makefile : Install required Go CLI tools including gotestsum, govulncheck, gofumpt, msgp, ifacemaker, betteralign, and modernize

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Run `make audit` to execute go mod verify, go vet, and govulncheck for quality checks

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*_test.go : Run `make test` to execute the test suite with gotestsum

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*_test.go : Run `make coverage` to generate a coverage report

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*_bench_test.go : Run `make benchmark` to execute benchmarks with `go test`

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:37.127Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-26T11:06:37.127Z
Learning: Run `make format` to format the project when modifying code

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:37.127Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-26T11:06:37.127Z
Learning: Run `make test` to run the test suite when modifying code

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Run `make betteralign` to optimize struct field alignment for Go structs

Applied to files:

• AGENTS.md

📚 Learning: 2025-11-26T11:06:51.217Z

Learnt from: CR
Repo: gofiber/fiber PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-26T11:06:51.217Z
Learning: Applies to **/*.go : Run `make format` to apply code formatting using gofumpt

Applied to files:

• AGENTS.md

🔇 Additional comments (3)

AGENTS.md (3)

7-13: Well-structured coding practices guidelines.

The new "General coding practices" section is clear and actionable, providing developers with solid guidance on Go testing concurrency, preferred utilities, and secure-by-default practices. The alignment with project learnings is strong.

---

61-75: Programmatic checks section now includes linting.

The addition of make lint at line 73 appropriately addresses the previous concern about missing linting checks. The placement in the workflow sequence is logical.

---

1-75: Based on my verification, the review comment's request to run make markdown is correct and necessary. Here's what I found:

1. Makefile confirms markdown linting support: The Makefile contains a markdown: target (line 34) that executes markdownlint-cli2 "**/*.md" "#vendor" to lint all markdown files.

2. Coding guideline requires it: Per the coding guidelines provided, **/*.md files must pass make markdown when modified.

3. File was modified: AGENTS.md (77 lines) has been updated and needs linting verification.

4. Sandbox limitation: The sandbox environment lacks npm and make commands needed to execute this verification directly, so I cannot confirm pass/fail status.

Run make markdown locally to verify AGENTS.md passes markdown linting before merging.