Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add code guidelines description#408

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
ganeshpatro321 merged 2 commits intomainfromcode-guidelines
Jun 24, 2025
Merged

Conversation

ganeshpatro321
Copy link
Contributor

No description provided.

@cloudflare-workers-and-pagesCloudflare Workers and Pages
Copy link

cloudflare-workers-and-pagesbot commentedJun 23, 2025
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit:d8ce3c5
Status: ✅  Deploy successful!
Preview URL:https://b17c55ad.coderabbit-docs.pages.dev
Branch Preview URL:https://code-guidelines.coderabbit-docs.pages.dev

View logs

@ganeshpatro321ganeshpatro321force-pushed thecode-guidelines branch 2 times, most recently fromd9e2278 tocfdef2cCompareJune 23, 2025 13:38
@coderabbitaicoderabbitai
Copy link
Contributor

coderabbitaibot commentedJun 23, 2025
edited
Loading

"""

Walkthrough

A new "Code Guidelines" section has been added to the documentation, detailing how CodeRabbit can analyze and learn from organizational code guidelines configured in the knowledge base. The section specifies default file patterns for guideline detection and includes an illustrative image.

Changes

File(s)Change Summary
docs/integrations/knowledge-base.mdAdded "Code Guidelines" section, described guideline detection, listed file patterns, and added an illustrative image.

Poem

In the warren of docs, a new path appears,
Code guidelines now crystal clear.
Patterns and rules, all neatly defined,
Helping reviews with knowledge aligned.
With images bright and markdown delight,
CodeRabbit hops on, making code 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 betweencfdef2c andd8ce3c5.

⛔ Files ignored due to path filters (1)
  • static/img/knowledge-base/code-guidelines.png is excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
  • docs/integrations/knowledge-base.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/integrations/knowledge-base.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Cloudflare Pages
✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branchcode-guidelines

🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

  • 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 oursupport 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 togenerate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests 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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
docs/integrations/knowledge-base.md (4)

28-28:Correct verb usage and maintain consistent spelling.
Replace the verb “setup” with “set up” and harmonize spelling (e.g., US English “analyze” and “organization’s”).

- CodeRabbit will analyse and learn from your organisation's code guidelines, which you can setup in the knowledge base section.+ CodeRabbit will analyze and learn from your organization's code guidelines, which you can set up in the knowledge base section.

30-30:Fix grammar in the patterns introduction.
Change “These set of patterns are scanned by default.” to a clearer phrasing such as “The following patterns are scanned by default.”

- These set of patterns are scanned by default.+ The following patterns are scanned by default.

32-40:Specify code fence language for syntax highlighting.
Add a language identifier (e.g.,text oryaml) after the opening triple backticks to improve readability.

- ```+ ```text

42-42:Enhance image alt text for accessibility.
Use more descriptive alt text to convey the image’s purpose.

- ![Code guidelines image](/img/knowledge-base/code-guidelines.png)+ ![Illustration of code guidelines scanning patterns](/img/knowledge-base/code-guidelines.png)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and betweenb448a3c andcfdef2c.

⛔ Files ignored due to path filters (1)
  • static/img/knowledge-base/code-guidelines.png is excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
  • docs/integrations/knowledge-base.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/integrations/knowledge-base.md

[grammar] ~28-~28: The word “setup” is a noun. The verb is spelled with a space.
Context: ...sation's code guidelines, which you can setup in the knowledge base section. These gu...

(NOUN_VERB_CONFUSION)

🪛 markdownlint-cli2 (0.17.2)
docs/integrations/knowledge-base.md

32-32: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages

@ganeshpatro321ganeshpatro321 merged commit7122194 intomainJun 24, 2025
4 checks passed
@ganeshpatro321ganeshpatro321 deleted the code-guidelines branchJune 24, 2025 09:52
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@ankitjenaankitjenaankitjena approved these changes

@coderabbitaicoderabbitai[bot]coderabbitai[bot] 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
@ganeshpatro321@ankitjena

[8]ページ先頭

©2009-2025 Movatter.jp