Skip to content

refactor!: Move externally usable assets into exports to distinguish them from assets for use only within the repo.#37

Merged
kirkrodrigues merged 1 commit into
y-scope:mainfrom
kirkrodrigues:exports
Mar 16, 2025
Merged

refactor!: Move externally usable assets into exports to distinguish them from assets for use only within the repo.#37
kirkrodrigues merged 1 commit into
y-scope:mainfrom
kirkrodrigues:exports

Conversation

@kirkrodrigues

@kirkrodrigues kirkrodrigues commented Mar 13, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

In the near future, we plan to add automated linting for this repo. To distinguish those tasks from externally-usable tasks in this repo, we move all externally usable assets (lint-configs & taskfiles) into a new exports directory.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

N/A

Summary by CodeRabbit

  • Documentation
    • Revised the documentation for C++ linting tools to reflect the updated locations of configuration files.

@kirkrodrigues kirkrodrigues requested a review from a team as a code owner March 13, 2025 21:22
@coderabbitai

coderabbitai Bot commented Mar 13, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The documentation for C++ linting tools was updated to reflect a new directory structure. Paths referencing configuration files—specifically for .clang-format, .clang-tidy, and the symlink script—were modified to point from ../lint-configs/ to ../exports/lint-configs/. No changes were made to the tools' functionality.

Changes

File Summary
docs/lint-tools-cpp.md Updated configuration file paths for .clang-format, .clang-tidy, and symlink-cpp-lint-configs.sh from ../lint-configs/ to ../exports/lint-configs/

Suggested reviewers

  • davidlion

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
📜 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 e6b3f0c and a8d0550.

📒 Files selected for processing (1)
  • docs/lint-tools-cpp.md (1 hunks)
🔇 Additional comments (1)
docs/lint-tools-cpp.md (1)

71-73: Ensure Documentation Reflects New Asset Locations
The updated paths now correctly reference the new locations in the exports/lint-configs directory, which aligns well with the reorganisation objective. Ensure that the assets are in these new locations so that the documentation remains accurate for external users.

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.
    • 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 generate docstrings to generate docstrings for 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.

@kirkrodrigues kirkrodrigues requested a review from davidlion March 15, 2025 16:33
@kirkrodrigues kirkrodrigues changed the title refactor!: Move externally usable assets to distinguish them from assets for use only within the repo. refactor!: Move externally usable assets into exports to distinguish them from assets for use only within the repo. Mar 16, 2025
@kirkrodrigues kirkrodrigues merged commit 35b0b2b into y-scope:main Mar 16, 2025
@kirkrodrigues kirkrodrigues mentioned this pull request Apr 4, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidlion davidlion davidlion approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kirkrodrigues @davidlion