Skip to content

Commit

Permalink
markdown source builds
Browse files Browse the repository at this point in the history
Auto-generated via `{sandpaper}`
Source  : d596a6c
Branch  : main
Author  : Dimitrios Theodorakis <astrodimitrios@gmail.com>
Time    : 2025-01-09 15:13:19 +0000
Message : MetOffice#40 Adds in a caution about the pre-commit checks failing
  • Loading branch information
actions-user committed Jan 9, 2025
1 parent b8a8b6c commit 5146935
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 2 deletions.
16 changes: 16 additions & 0 deletions 03-feature-branch.md
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 04-review.md
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
4 changes: 2 additions & 2 deletions md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"episodes/00-repo-access.md" "69149f4f1439ae3798eab748291c5b33" "site/built/00-repo-access.md" "2025-01-09"
"episodes/01-issues.md" "a2cd906c1fd69b1be899f6e352334b0d" "site/built/01-issues.md" "2025-01-09"
"episodes/02-branching.md" "67c14934ca1f8eced9b2c82159d54842" "site/built/02-branching.md" "2025-01-09"
"episodes/03-feature-branch.md" "6d1c374b7fce14da1bdaa046fc4d756a" "site/built/03-feature-branch.md" "2025-01-09"
"episodes/04-review.md" "6b8f2d8bb2981c6325884bfe252efa27" "site/built/04-review.md" "2025-01-09"
"episodes/03-feature-branch.md" "2aa2c1b8bd6bf77202e3dfecc69eca2d" "site/built/03-feature-branch.md" "2025-01-09"
"episodes/04-review.md" "1b99410868758ff2a0c92ed59383dd06" "site/built/04-review.md" "2025-01-09"
"episodes/Break.md" "96f3c03ec9cd646c6366f840b7f21107" "site/built/Break.md" "2025-01-09"
"episodes/05-forks.md" "47b583e34640bfbf92abb84c2c97540c" "site/built/05-forks.md" "2025-01-09"
"episodes/06-conflict.md" "a8d0c3432d9ba941acb7607a264f117a" "site/built/06-conflict.md" "2024-12-03"
Expand Down

0 comments on commit 5146935

Please sign in to comment.