Skip to content

feat(snippet-bot): Clarify which items are violations and which are not #1445

@tmatsuo

Description

@tmatsuo

Example PR: GoogleCloudPlatform/php-docs-samples#1282

Since the first one has a title ("Here is a summary of possible violations") and the second and third ones don't, it looks like the title applies to all three. It would be clearer if you had a title above the second and third sections that said something like "Here is a summary of safe code snippet deletions" or something.

When I saw the PR, I did not intuitively understand that you meant that the second and third sections were separate from the first. I am just one user, but if one user can be confused, any user can be confused.

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions