Skip to content

Commit b5021b8

Browse files
authored
doc(CONTRIBUTING.md): clarify test health expectations on go test ./... (#2715)
Updates the test health guidelines to clarify that `go test ./...` should always pass on a fresh clone, without any non-standard services or external tools running.
1 parent eb25308 commit b5021b8

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ standard process is to [revert it through the GitHub interface](https://docs.git
294294
To revert a pull request:
295295
1. Navigate to the merged pull request on GitHub.
296296
2. Click the **Revert** button. This action automatically creates a new branch and a pull request containing the revert commit.
297-
3. Edit the pull request title and description to comply with the [commit message guidelines](#commit-messages).
297+
3. Edit the pull request title and description to comply with the [commit message guidelines](#commit-messages).
298298
4. The newly created revert pull request should be reviewed and merged following the same process as any other pull request.
299299

300300
Using the GitHub "Revert" button is the preferred method over manually creating a revert commit using `git revert`.
@@ -371,7 +371,7 @@ When reviewing a pull request:
371371
[user-review-requested:@me](https://github.com/googleapis/librarian/pulls?q=is%3Apr+is%3Aopen+user-review-requested%3A%40me)
372372
search view is helpful for tracking PRs awaiting your review.
373373

374-
### Test Health
374+
### Maintaining a Healthy Main Branch
375375

376376
All pull requests require passing CI checks to be merged.
377377

@@ -384,3 +384,10 @@ stability.
384384

385385
All other development should be deprioritized until green builds can
386386
be guaranteed.
387+
388+
Running `go test ./...` on a fresh clone of this repository should always pass,
389+
without requiring anything besides `go` installed. Tests that depend on other
390+
tools or services (e.g., docker, protoc, etc.) should be skipped when those
391+
tools are not available in the development environment. See
392+
[doc/onboarding.md](https://github.com/googleapis/librarian/blob/main/doc/onboarding.md)
393+
for information on how to configure your development environment.

0 commit comments

Comments
 (0)