Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds in a caution about the pre-commit checks failing #40

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Adds in a caution about the pre-commit checks failing #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions episodes/03-feature-branch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
16 changes: 16 additions & 0 deletions episodes/04-review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Click on the file icon or press <kbd>Ctrl+g</kbd>:

![](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**,
Expand Down Expand Up @@ -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
Expand Down