diff --git a/episodes/03-feature-branch.md b/episodes/03-feature-branch.md index feb52dc..e1efb46 100644 --- a/episodes/03-feature-branch.md +++ b/episodes/03-feature-branch.md @@ -275,6 +275,22 @@ for trailing whitespace, accidentally adding large files etc. More information can be found in the optional episode on [pre-commit hooks](./09-pre-commit.md). +::: caution + +## Help: Some checks have failed + +If your now open Pull Request says some checks have failed +this is because your changes did not pass the automatic +pre-commit checks. + +Click on the **Details** link next to the failed test +and fix your code on your local repository. +Commit and then push this fix to GitHub. +Your PR will automatically update and re-run the tests, +you may need to refresh the page. + +::: + ### Automatically closing Issues via PRs A PR can automatically close an Issue when it is merged into `main`. diff --git a/episodes/04-review.md b/episodes/04-review.md index 60850b6..c5b0731 100644 --- a/episodes/04-review.md +++ b/episodes/04-review.md @@ -68,6 +68,7 @@ Click on the file icon or press Ctrl+g: ![](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.'} +Add in a suggested change for your review. Click on the green **Start a review** button. Now click on the green button in the top right which says **Finish your review** or **Review Changes**, @@ -100,6 +101,21 @@ and then marked the conversation with the suggested change as resolved. Re-request a review by clicking on the two arrows forming a circle next to the reviewers name at the top of the PR. +::: caution + +## Help: Some checks have failed + +Since our PR is running automatic checks it's best +not to make large changes by accepting suggestions this way. +Instead make changes to your feature branch using your local copy, +run the [checks locally](09-pre-commit.md), +push the changes to GitHub +and then mark the conversations with the suggested changes as resolved. +You can add a commit hash in the conversation which will automatically +link to the commit responding to any review comments. + +::: + ## Approving Changes Head back to your partners PR, if they re-requested a review