Skip to content

Commit 54afae5

Browse files
Adds in a caution about the pre-commit checks failing
1 parent 055b9e7 commit 54afae5

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

episodes/03-feature-branch.md

+16
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,22 @@ for trailing whitespace, accidentally adding large files etc.
275275
More information can be found in the optional episode on
276276
[pre-commit hooks](./09-pre-commit.md).
277277

278+
::: caution
279+
280+
## Help: Some checks have failed
281+
282+
If your now open Pull Request says some checks have failed
283+
this is because your changes did not pass the automatic
284+
pre-commit checks.
285+
286+
Click on the **Details** link next to the failed test
287+
and fix your code on your local repository.
288+
Commit and then push this fix to GitHub.
289+
Your PR will automatically update and re-run the tests,
290+
you may need to refresh the page.
291+
292+
:::
293+
278294
### Automatically closing Issues via PRs
279295

280296
A PR can automatically close an Issue when it is merged into `main`.

episodes/04-review.md

+16
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Click on the file icon or press <kbd>Ctrl+g</kbd>:
6868

6969
![](fig/pr-suggestion.png){alt='A screenshot of a PR showing the diff in the Files changed tab. A line has been highlighted to show how to add an inline comment with a suggestion.'}
7070

71+
Add in a suggested change for your review.
7172
Click on the green **Start a review** button.
7273
Now click on the green button in the top right which says
7374
**Finish your review** or **Review Changes**,
@@ -100,6 +101,21 @@ and then marked the conversation with the suggested change as resolved.
100101
Re-request a review by clicking on the two arrows forming a circle
101102
next to the reviewers name at the top of the PR.
102103

104+
::: caution
105+
106+
## Help: Some checks have failed
107+
108+
Since our PR is running automatic checks it's best
109+
not to make large changes by accepting suggestions this way.
110+
Instead make changes to your feature branch using your local copy,
111+
run the [checks locally](09-pre-commit.md),
112+
push the changes to GitHub
113+
and then mark the conversations with the suggested changes as resolved.
114+
You can add a commit hash in the conversation which will automatically
115+
link to the commit responding to any review comments.
116+
117+
:::
118+
103119
## Approving Changes
104120

105121
Head back to your partners PR, if they re-requested a review

0 commit comments

Comments
 (0)