Skip to content

📚 Doc: fix AGENTS markdown lint#3460

Merged
ReneWerner87 merged 1 commit intogofiber:mainfrom
mdelapenya:fix-agents-md
May 19, 2025
Merged

📚 Doc: fix AGENTS markdown lint#3460
ReneWerner87 merged 1 commit intogofiber:mainfrom
mdelapenya:fix-agents-md

Conversation

@mdelapenya
Copy link
Contributor

@mdelapenya mdelapenya commented May 19, 2025

Description

Please provide a clear and concise description of the changes you've made and the problem they address. Include the purpose of the change, any relevant issues it solves, and the benefits it brings to the project. If this change introduces new features or adjustments, highlight them here.

Fixes # (issue)

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

@mdelapenya mdelapenya requested a review from a team as a code owner May 19, 2025 08:26
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 19, 2025 •
edited
Loading

Walkthrough

The update modifies the formatting of section headers in the AGENTS.md file by removing trailing spaces after colons and adding blank lines following each header. No changes were made to the code blocks or commands, and no functional content was altered.

Changes

File(s) Change Summary
AGENTS.md Adjusted markdown formatting: removed trailing spaces after colons in headers and added blank lines after each header. No content or code changes.

Poem

🐇
With tidy headers, clear and neat,
Markdown lines now look complete.
Spaces trimmed, and gaps appear,
For every reader, far and near.
Formatting shines, so crisp and bright—
The docs now read just right!

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc6a190 and bffd13f.

📒 Files selected for processing (1)
  • AGENTS.md (1 hunks)
🔇 Additional comments (2)
AGENTS.md (2)

5-6: Whitespace fix for "Fetch dependencies:" header.
Removed the trailing space after the colon and added a blank line below the header to satisfy markdown-lint requirements.

11-12: Whitespace fix for "Install CLI tools referenced in Makefile:" header.
Removed the trailing space after the colon and added a blank line below the header to satisfy markdown-lint requirements.

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.

@mdelapenya mdelapenya changed the title docs: fix AGENTS markdown lint 📚 Doc: fix AGENTS markdown lint May 19, 2025
@ReneWerner87 ReneWerner87 merged commit 5b6795f into gofiber:main May 19, 2025
3 checks passed
@welcome
Copy link

welcome bot commented May 19, 2025

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

mdelapenya added a commit to mdelapenya/fiber that referenced this pull request May 19, 2025
@mdelapenya
Merge branch 'main' into runtime-dependencies
1f7e290 
* main:
  📚 Doc: fix AGENTS markdown lint (gofiber#3460)
@coderabbitai coderabbitai bot mentioned this pull request May 19, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 21, 2025
Merged
20 tasks
@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

@ReneWerner87 ReneWerner87 ReneWerner87 approved these changes

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

@sixcolors sixcolors Awaiting requested review from sixcolors sixcolors 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

☢️ Bug 📒 Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mdelapenya @ReneWerner87