You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -70,14 +71,21 @@ CodeRabbit takes a moment to set up the integration. After it finishes, the Code
70
71
71
72
To add CodeRabbit to your test repository, follow these steps:
72
73
73
-
1. On the CodeRabbit dashboard, click **Add Repositories**. A GitHub repository-access dialog appears.
74
-
1. Select the **Only select repositories** radio button.
75
-
1. From the **Select repositories** menu, select the `coderabbit-test` repository that you created earlier in this Quickstart.
76
-
1. Click **Install & Authorize**.
77
-
:::note
78
-
CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
79
-
:::
80
-
1. If a CodeRabbit **Complete your signup** dialog appears, then fill it out with the requested information before continuing.
74
+
<ListItems
75
+
orderedList
76
+
items={[
77
+
<>On the CodeRabbit dashboard, click <strong>Add Repositories</strong>.</>,
78
+
<>Select the <strong>Only select repositories</strong> radio button.</>,
79
+
<>From the <strong>Select repositories</strong> menu, select the <code>coderabbit-test</code> repository that you created earlier in this Quickstart.</>,
80
+
<>
81
+
Click <strong>Install & Authorize</strong>.
82
+
<Note>
83
+
CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see <ahref="https://trust.coderabbit.ai">the CodeRabbit Trust Center</a>.
84
+
</Note>
85
+
</>,
86
+
<>If a CodeRabbit <strong>Complete your signup</strong> dialog appears, then fill it out with the requested information before continuing.</>,
87
+
]}
88
+
/>
81
89
82
90
CodeRabbit is now ready to use with your test repository. The next steps demonstrate its core code-review features.
83
91
@@ -93,19 +101,18 @@ Use your usual Git workflow to perform the following steps in the `coderabbit-te
93
101
"Create a branch named `add-utils`.",
94
102
<>
95
103
In that new <code>add-utils</code> branch, create a new file called <code>simple_utils.py</code>, with the following content:
96
-
<CodeBlocklanguage="python">{`
97
-
# simple_utils.py - A tiny utility library
104
+
<DarkCodeBlocklanguage="python">{`# simple_utils.py - A tiny utility library
98
105
99
106
def reverse_string(text):
100
-
"""Reverses the characters in a string."""
101
-
return text[::-1]
107
+
"""Reverses the characters in a string."""
108
+
return text[::-1]
102
109
103
110
def count_words(sentence):
104
-
return len(sentence.split())
111
+
return len(sentence.split())
105
112
106
113
def celsius_to_fahrenheit(celsius):
107
-
return (celsius \* 9/5) + 32
108
-
`}</CodeBlock>
114
+
return (celsius * 9/5) + 32
115
+
`}</DarkCodeBlock>
109
116
</>,
110
117
"Commit the added file to the `add-utils`branch. Use any text you want for the commit message.",
111
118
"Create a pull request that proposes to merge the`add-utils`branch into the`main` branch. Use any text you want for the pull request message.",
@@ -116,12 +123,10 @@ After a few moments, CodeRabbit responds to the pull request using the `@coderab
116
123
117
124
<ListItems
118
125
items={[
119
-
"If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.",
120
-
"CodeRabbit posts a comment titled **Walkthrough** containing analysis and commentary about the content of the pull request.",
121
-
"CodeRabbit attaches a detailed code review to the pull request as another comment.",
122
-
123
-
]}
124
-
126
+
<>If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.</>,
127
+
<>CodeRabbit posts a comment titled <strong>Walkthrough</strong> containing analysis and commentary about the content of the pull request.</>,
128
+
<>CodeRabbit attaches a detailed code review to the pull request as another comment.</>,
129
+
]}
125
130
/>
126
131
127
132
Part of the review resembles the following screenshot:
@@ -136,33 +141,31 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
136
141
137
142
1. Post the following as a new GitHub comment attached to the pull request:
138
143
139
-
```text
140
-
@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
141
-
```
144
+
<ChatBubble>@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?</ChatBubble>
142
145
143
-
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
146
+
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
144
147
145
148
<ChatBubble>
146
-
{`> You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessary for every function, especially in smaller projects with clear function names.
147
-
>
148
-
> While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
149
-
>
150
-
> If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?`}
149
+
{`You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessary for every function, especially in smaller projects with clear function names.
150
+
151
+
While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
152
+
153
+
If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?`}
151
154
</ChatBubble>
152
155
153
156
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions.
0 commit comments