Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Doc: Update What's New documentation #3181

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Conversation

alequilesl
Copy link
Contributor

Balance brakets in Router/Route chaining.

  • [x ] Documentation Update: Balance brakets in Router/Route chaining.

Type of change

  • [x ] Documentation update (changes to documentation)

@alequilesl alequilesl requested a review from a team as a code owner October 26, 2024 02:35
@alequilesl alequilesl requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team October 26, 2024 02:35
Copy link

welcome bot commented Oct 26, 2024

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Oct 26, 2024

Walkthrough

The pull request updates the whats_new.md document to reflect the release of Fiber v3, detailing significant changes and migration instructions from Fiber v2. Key changes include the removal of support for older Go versions, restructuring of app configuration, and modifications to the router interface and method signatures. New features in context management and the client package are introduced, while several methods are deprecated. Migration guides emphasize adapting to these changes, showcasing a substantial evolution of the Fiber framework.

Changes

File Change Summary
docs/whats_new.md Updated to detail Fiber v3 release, significant changes, migration instructions, and new features in context management and client package.
github.com/gofiber/fiber/v2 Method signatures for HTTP methods (Get, Head, Post, Put, Delete, Connect, Options, Trace, Patch, All) updated to enforce explicit handler and middleware usage. Added method RebuildTree().

Possibly related PRs

  • Update README.md #3165: The README.md update includes a change in the function signature for route handlers, which is directly related to the modifications in method signatures for HTTP method registrations in the main PR.

Suggested labels

📒 Documentation

Suggested reviewers

  • gaby
  • sixcolors
  • ReneWerner87
  • efectn

Poem

In the garden of code, changes bloom bright,
Fiber v3's here, oh what a sight!
With new paths to tread, and methods refined,
A leap into the future, so well-defined.
Hop along, dear friends, let’s embrace the new,
For in every update, there's magic to pursue! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e3232c1 and 3367ecf.

📒 Files selected for processing (1)
  • docs/whats_new.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/whats_new.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

@gaby gaby added this to the v3 milestone Oct 26, 2024
@gaby gaby changed the title Doc: balance brakets 📚 Doc: Update What's New documentation Oct 26, 2024
@gaby gaby merged commit 454c166 into gofiber:main Oct 26, 2024
3 checks passed
Copy link

welcome bot commented Oct 26, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants