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
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/getting-started/quickstart.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,29 +58,29 @@ Use your usual Git workflow to perform the following steps in the `coderabbit-te
58
58
59
59
1. In that new`add-utils` branch, create a new file called`simple_utils.py`, with the following content:
60
60
61
-
```python
62
-
# simple_utils.py - A tiny utility library
61
+
```python
62
+
# simple_utils.py - A tiny utility library
63
63
64
-
defreverse_string(text):
65
-
"""Reverses the characters in a string."""
66
-
return text[::-1]
64
+
defreverse_string(text):
65
+
"""Reverses the characters in a string."""
66
+
return text[::-1]
67
67
68
-
defcount_words(sentence):
69
-
returnlen(sentence.split())
68
+
defcount_words(sentence):
69
+
returnlen(sentence.split())
70
70
71
-
defcelsius_to_fahrenheit(celsius):
72
-
return (celsius*9/5)+32
73
-
```
71
+
defcelsius_to_fahrenheit(celsius):
72
+
return (celsius*9/5)+32
73
+
```
74
74
75
75
1. Commit the added file to the`add-utils` branch. Use any text you want for the commit message.
76
76
77
77
1. 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.
78
78
79
79
After a few moments, CodeRabbit responds to the pull request using the`@coderabbitai` GitHub account. It performs the following actions, all of which are visible on the pull request's page on GitHub:
80
80
81
-
* If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.
82
-
* CodeRabbit posts a comment titled**Walkthrough** containing analysisand commentary about the content of the pull request.
83
-
* CodeRabbit attaches a detailed code review to the pull requestas another comment.
81
+
- If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.
82
+
- CodeRabbit posts a comment titled**Walkthrough** containing analysis and commentary about the content of the pull request.
83
+
- CodeRabbit attaches a detailed code review to the pull request as another comment.
84
84
85
85
Part of the review resembles the following screenshot:
86
86
@@ -94,31 +94,31 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
94
94
95
95
1. Post the following as a new GitHub comment attached to the pull request:
96
96
97
-
```text
98
-
@coderabbitai Why doall of these functions need docstrings? Isn't it obvious enough what they do?
99
-
```
97
+
```text
98
+
@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
99
+
```
100
100
101
-
After a few moments, CodeRabbit posts its reply, explaining its motivationsfor its recommendation. The reply might resemble the following:
101
+
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
102
102
103
-
> You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessaryfor every function, especiallyin smaller projectswith clear function names.
104
-
>
105
-
> While docstrings do provide benefits (IDE tooltips, documentation generation,helpfor future developers), they can sometimes feel redundantfor very straightforward functions. It's ultimately a matter of coding style and project requirements.
106
-
>
107
-
> If you prefer to skip docstringsfor obvious utility functionsin this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?
103
+
>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.
104
+
>
105
+
>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.
106
+
>
107
+
>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?
108
108
109
-
In this case, CodeRabbitis offering to adjust its future behavior when reviewing changes to this repository. Instead, follow thenext step to ask CodeRabbit to implement part of its suggestions.
109
+
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.
110
110
111
111
1. Post the following as another new comment:
112
112
113
-
```text
114
-
@coderabbitai generate docstrings
115
-
```
113
+
```text
114
+
@coderabbitai generate docstrings
115
+
```
116
116
117
-
After a few moments, CodeRabbit does the following:
117
+
After a few moments, CodeRabbit does the following:
118
118
119
-
* CodeRabbit creates a new branch, based on`add-utils`.
120
-
* CodeRabbit commits changes to the branch that adds suggested docstrings to`add-utils`.
121
-
* CodeRabbit opens a new pull request between the new branchand`add-utils`.
119
+
- CodeRabbit creates a new branch, based on`add-utils`.
120
+
- CodeRabbit commits changes to the branch that adds suggested docstrings to`add-utils`.
121
+
- CodeRabbit opens a new pull request between the new branch and`add-utils`.
122
122
123
123
##Clean up
124
124
@@ -128,8 +128,8 @@ You are now ready to add CodeRabbit to other repositories that you own, and let
128
128
129
129
##What's next
130
130
131
-
* [Integrate CodeRabbit](/platforms/)with your repositories on GitHub, GitLab, Azure DevOps,or Bitbucket.
132
-
* [Configure CodeRabbit](/getting-started/configure-coderabbit) beyond its default settings.