RFR: More on testing [v2]

[Jesper Wilhelmsson]

On Mon, 27 Feb 2023 20:15:19 GMT, Stuart Marks <smarks at openjdk.org> wrote:

>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Fixed review comments
>
> src/guide/testing-the-jdk.md line 184:
> 
>> 182: ## Excluding a test
>> 183: 
>> 184: Sometimes tests break. It could be e.g. due to bugs in the test itself, due to changed functionality in the code that the test is testing, or changes in the environment where the test is executed. While working on a fix, it can be useful to stop the test from being executed in everyone else's testing to reduce noise, especially if the test is expected to fail for more than a day. There are two ways to stop a test from being run in standard test runs: ProblemListing and using the `@ignore` keyword. Removing tests isn't the standard way to remove a failure. A failing test is often a regression and should ideally be handled with high urgency.
> 
> The next paragraph begins,
> 
>> I'll say it right away so that it's not forgotten at the end:
> 
> This is an odd first person wording here. In this case the introductory clause doesn't add anything so I'd suggest simply removing it.

Fixed.

> src/guide/working-with-pull-requests.md line 27:
> 
>> 25: * Is the copyright statement at the top of each modified source file correct?
>> 26: 
>> 27: * Did you run all relevant tests on the final version of the change? **Yes, I mean final!** If you knew how many times people _only changed a comment_ and caused a build failure you wouldn't question this.
> 
> I agree with the sentiment here, but the tone is a little odd. It's one of only a couple places in the Guide where it refers to itself in the first person. When I run across wording like this I immediately think, "Who is the author?" In writing such as a blog post or newspaper column, there is a by-line, and so it's clear who is speaking. I don't think that's the case here, so it's just kind of strange.
> 
> The point is worth making though, so I'd suggest substituting something like,
> 
>> Did you run a full build and all relevant tests on the **final** version of the change? (It's important to do this on the truly final version, as even an apparently trivial change in a comment can break the build.)
> 
> The other use of first person is in testing-the-jdk.md; I'll make a comment there.

Fixed.

-------------

PR Review Comment: https://git.openjdk.org/guide/pull/98#discussion_r1179523405
PR Review Comment: https://git.openjdk.org/guide/pull/98#discussion_r1179523557