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
Copy file name to clipboardExpand all lines: org-cyf-guides/content/reviewing/trainee-pr-guide/index.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ mentors and teammates can:
17
17
- 👍 Review and provide feedback (approve or request improvements)
18
18
19
19
For most coursework, merging will not happen. You will update your code based on feedback, learn
20
-
from the process, and keep practicing.
20
+
from the process, and keep practising.
21
21
22
22
To get the most out of a PR, follow these steps to get
23
23
clear feedback, show your progress, and learn more effectively.
@@ -158,11 +158,27 @@ Replace the placeholder text by your questions, or delete the section if you don
158
158
## After Opening a PR
159
159
160
160
### Use labels to communicate the PR status
161
+
Reviewers will not check your PR unless it has the right label.
161
162
162
-
- Add **`Need review`** label to the PR.
163
+
- Add the **`Needs review`** label to the PR.
163
164
- For details about how to use labels in a PR, please refer to the [Using Labels](./using-labels/)
164
165
Guide.
165
166
167
+
### Check for automated feedback
168
+
169
+
Here at CYF we use bots to do some automated checks on your pull request.
170
+
If you ever get a reply from a bot, that means something needs to be fixed on your pull request.
171
+
This could mean something is missing from your submission, a problem in the title or description, or an issue with your submitted files.
172
+
173
+
If you see a comment in your PR from the user called **`github-actions`**, here's what to do:
174
+
175
+
- Carefully read the comments from the bot, this will explain what you should change
176
+
- Do this change and the bot will automatically check your submission again
177
+
- After making a change, if the bot leaves another reply, read it again and try to fix the problem
178
+
- If you still don't understand what needs fixing, ask for help on slack
179
+
- Once you have resolved the issue, add the **`Needs review`** label again to your PR
180
+
181
+
Learning how to respond to automated checks is important, because these kinds of tools are often used in software development work.
166
182
167
183
### Wait for Review
168
184
- It may take up to a week (sometimes longer) before someone starts reviewing your PR.
@@ -193,6 +209,8 @@ Responding to PR feedback is like a conversation: **listen**, **reply thoughtful
193
209
4.**Ask questions if unclear**
194
210
- If you don't understand a suggestion, ask for clarification.
195
211
- Example: _"Could you explain what you mean by simplifying this function?"_
212
+
213
+
After you have taken action and replied to your feedback, you should add the **`Needs review`** label again, so the reviewer knows you are ready for your submission to be checked again.
196
214
197
215
198
216
{{<notetype="tip"title="Writing on GitHub">}}
@@ -204,4 +222,15 @@ in places like repository READMEs and comments on pull requests and issues.
204
222
To learn how to write in Markdown, embed image, tag users, and other advanced features,
205
223
visit [GitHub Docs - Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
206
224
207
-
{{</note>}}
225
+
{{</note>}}
226
+
227
+
## Completing a PR
228
+
229
+
After you get feedback from a reviewer, you may make changes and have a back-and-forth discussion.
230
+
When the reviewer is happy that you have understood the task, and you have answered any questions they have, they will add the **`Complete`** label to your PR.
231
+
Your backlog task is not complete until the reviewer adds this label.
232
+
233
+
If you spend a long time waiting for the **`Complete`** label to be added, check the PR to make sure there are no comments from the reviewer that you missed.
234
+
If you think you have answered everything, and you are still waiting, you can ask for help on slack.
235
+
236
+
You can work on other tasks while you are waiting for reviews or completion on one PR, remember to do other tasks on a different branch.
0 commit comments