Bug or Enhancement

[JesperIRL]

Some clarifications on how to determine if an issue is a bug or an enhancement.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace

Reviewers

• Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/guide.git pull/172/head:pull/172
$ git checkout pull/172

Update a local copy of the PR:
$ git checkout pull/172
$ git pull https://git.openjdk.org/guide.git pull/172/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 172

View PR using the GUI difftool:
$ git pr show -t 172

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/guide/pull/172.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jwilhelm! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@JesperIRL This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

Bug or Enhancement

Reviewed-by: iris

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[mlbridge]

Webrevs

• 03: Full - Incremental (ddc7fcb7)
• 02: Full - Incremental (e2d8b923)
• 01: Full - Incremental (55c59728)
• 00: Full (7df848b2)

[aivanov-jdk]

Does it make sense to always capitalise “Group” and to always link it to the description? One link in the first sentence should be enough.

[aivanov-jdk]

Does the mark-down processor create the link automatically?

[aivanov-jdk]

Suggested change

	To decide whether an issue is a bug or an enhancement is not always straight forward. The basic distinction is not complex; If the detected behavior breaks the specification, it's a bug. If the intended behavior changes the specification, it's an enhancement. To make the right choice in reality, it might help to consider a few things:
	To decide whether an issue is a bug or an enhancement is not always straight forward. The basic distinction is not complex. If the detected behavior breaks the specification, it's a bug. If the intended behavior changes the specification, it's an enhancement. To make the right choice in reality, it might help to consider a few things:

The capital letter of “If” implies the semicolon should be full stop… that ends the sentence.

Alternatively, you may use a colon and make the two sentences that start with “if” a list item.

[aivanov-jdk]

Suggested change

	: Performance issues rarely breaks any specification, but in general these can be divided into two categories: Performance regressions (bugs) and Performance enhancements. If something has worse performance than it used to have, that is a regression. While if you are looking to improve performance of something that has not recently regressed, it's an enhancement.
	: Performance issues rarely break any specification, but in general these can be divided into two categories: Performance regressions (bugs) and Performance enhancements. If something has worse performance than it used to have, that is a regression. While if you are looking to improve performance of something that has not recently regressed, it's an enhancement.