Skip to content

Commit 7c0d794

Browse files
Add information on how to responded to automated review checks (#1682)
* needs review and bot * completing * minor formatting * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> * Update org-cyf-guides/content/reviewing/trainee-pr-guide/index.md Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io> --------- Co-authored-by: l <l> Co-authored-by: Daniel Wagner-Hall <daniel@codeyourfuture.io>
1 parent 75129c0 commit 7c0d794

File tree

1 file changed

+32
-3
lines changed
  • org-cyf-guides/content/reviewing/trainee-pr-guide

1 file changed

+32
-3
lines changed

org-cyf-guides/content/reviewing/trainee-pr-guide/index.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ mentors and teammates can:
1717
- 👍 Review and provide feedback (approve or request improvements)
1818

1919
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.
2121

2222
To get the most out of a PR, follow these steps to get
2323
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
158158
## After Opening a PR
159159

160160
### Use labels to communicate the PR status
161+
Reviewers will not check your PR unless it has the right label.
161162

162-
- Add **`Need review`** label to the PR.
163+
- Add the **`Needs review`** label to the PR.
163164
- For details about how to use labels in a PR, please refer to the [Using Labels](./using-labels/)
164165
Guide.
165166

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.
166182

167183
### Wait for Review
168184
- 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
193209
4. **Ask questions if unclear**
194210
- If you don't understand a suggestion, ask for clarification.
195211
- 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.
196214

197215

198216
{{<note type="tip" title="Writing on GitHub">}}
@@ -204,4 +222,15 @@ in places like repository READMEs and comments on pull requests and issues.
204222
To learn how to write in Markdown, embed image, tag users, and other advanced features,
205223
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).
206224

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

Comments
 (0)