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

Commit43b2d89

Browse files
authored
Clarify several best practices. (coderabbitai#389)
1 parentf066cdd commit43b2d89

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

‎docs/guides/setup-best-practices.md‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,21 @@ works with your individual repositories.
6464

6565
CodeRabbit gives you two ways to configure how it works with your team's repositories:
6666

67-
- The[Repositories](https://app.coderabbit.ai/settings/repositories) page of the
68-
Dashboard
67+
- The**Organization Settings** and**Repositories** pages of[the
68+
CodeRabbit web interface](https://app.coderabbit.ai/login)
6969
- A[`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
7070

71-
Thegraphical UI of the Repositories pagelets you set up yourper-repository
72-
preferencesmorerapidly, and can help you get familiar with CodeRabbit configuration options.
71+
Theweb interfacelets you set up yourorganization's code review
72+
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
7373

74-
Once you are ready to fine-tune the ways that CodeRabbit works with your repositories,
75-
we recommend adding a`coderabbit.yaml` file to each one. This file has several
76-
advantages over using only the Dashboard:
74+
We recommend adding a`coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
7775

78-
- It applies version control to your repository's CodeRabbit settings.
76+
- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
7977
- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
8078
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
8179

8280
Repository-level settings defined by a`coderabbit.yaml` take precedence over the
83-
settings defined for that repositoryintheDashboard.
81+
settings defined for that repositoryor for your organization usingtheCodeRabbit web interface.
8482

8583
For more information, see[Add a configuration file](/getting-started/configure-coderabbit/).
8684

@@ -89,14 +87,14 @@ For more information, see [Add a configuration file](/getting-started/configure-
8987
If your repository contains a lot of data or other content that CodeRabbit
9088
doesn't need for code review context, then you can include_path filters_ in
9189
your repository configuration. For example, a filter of`!dist/**` tells CodeRabbit
92-
to disregard everything in yourreposistory's top-level`dist` directory when
90+
to disregard everything in yourrepository's top-level`dist` directory when
9391
preparing a code review.
9492

9593
Reducing the number of contextual files that CodeRabbit needs to read and analyze
9694
when preparing a code review can help make its code reviews faster.
9795

9896
You can define path filters using the CodeRabbit
99-
web interface, or with[aconfiguration file](/getting-started/configure-coderabbit/).
97+
web interface, or with[a`coderabbit.yaml` file](/getting-started/configure-coderabbit/).
10098

10199
###Trust the defaults {#defaults}
102100

@@ -108,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
108106
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
109107
-**Knowledge base**: CodeRabbit[knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
110108

111-
You can configure your use of the above features using the CodeRabbit web interface, or[aconfiguration file](/getting-started/configure-coderabbit/).
109+
You can configure your use of the above features using the CodeRabbit web interface, or[a`coderabbit.yaml` file](/getting-started/configure-coderabbit/).
112110

113111
###Write specific CI/CD error messages {#pipeline}
114112

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp