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

Update examples directory structure #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NxPKG
Copy link
Owner

@NxPKG NxPKG commented Dec 3, 2024


For more details, open the Copilot Workspace session.

Summary by Sourcery

Reorganize the examples directory structure to group examples by framework or library, enhancing clarity and maintainability. Update the README.md to reflect the new structure and provide an overview of the examples available.

Enhancements:

  • Reorganize the examples directory to group examples by framework or library, providing a clearer structure.

Documentation:

  • Update the README.md in the examples directory to include a high-level overview of the new directory structure.

Copy link

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

This PR reorganizes the examples directory structure by introducing a more organized, framework-based hierarchy. The changes involve moving existing example projects into framework-specific subdirectories and adding a comprehensive directory structure documentation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduced a new hierarchical directory structure for examples
  • Added framework-specific directories (actix-web/, axum/, rocket/, warp/)
  • Created a generic/ directory for framework-agnostic examples
  • Added README.md files for each framework directory
  • Organized todo examples under generic/todo/ with framework-specific implementations
examples/README.md
Removed old flat directory structure files
  • Removed individual example directories from root examples/ folder
  • Removed associated Cargo.toml, README.md, and source files from old structure
examples/actix-web-multiple-api-docs-with-scopes/*
examples/actix-web-scopes-binding/*
examples/axum-fastapi-bindings/*
examples/axum-fastapi-nesting-vendored/*
examples/raw-json-actix/*
examples/rocket-todo/*
examples/todo-actix/*
examples/todo-axum/*
examples/todo-tide/*
examples/todo-warp/*
examples/todo-warp-rapidoc/*
examples/todo-warp-redoc-with-file-config/*
examples/warp-multiple-api-docs/*

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @NxPKG - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant