Skip to content

github: Wordsmith contributing checklist output #1964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
concussious wants to merge 1 commit into
base: main
Choose a base branch
from
Open

github: Wordsmith contributing checklist output #1964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/checklist.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,12 @@ jobs:
/* Loop for each key in "checklist". */
for (const c in checklist)
msg += "- " + c + " (" + checklist[c].join(", ") + ")\n";
msg += "\n> [!NOTE]\n> Please review [CONTRIBUTING.md](https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md), then update and push your branch again.\n\n"
msg += "\n> [!NOTE]\n> Please review the [CONTRIBUTING](https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md) guidelines, then update and push your branch again.\n\n"
} else {
let msg = "No Issues found.\n\n";
let msg = "[CONTRIBUTING](https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md) guideline checklist found no issues.\n\n";
Copy link
Member

@bsdimp bsdimp Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think no issues found was better...

Copy link
Member

@emaste emaste Jan 13, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO there is some value in including the link also in the "good" case - both because a user might recall this is where the link shows up, and also because it is more precise. Without context "No issues found." might be taken as an indication that the commit has passed code review, testing, etc.

Copy link
Member

@bsdimp bsdimp Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm willing to try it. Just seemed too verbose for n9thing to do.

Copy link
Contributor Author

@concussious concussious Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without context "No issues found." might be taken as an indication that the commit has passed code review, testing, etc.

That's what I was thinking. Someone might get really excited and then have their hopes dashed. I'm not attached to any specific wording though.

}
if (infolist_len != 0) {
msg += "Some of files have special handling:\n"
msg += "Directories with proposed changes have special handling:\n"
for (const i in infolist)
msg += i + "\n";
msg += "\n\n";
Expand All @@ -188,6 +188,6 @@ jobs:
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: comment_id,
body: msg_prefix + "All issues resolved."
body: msg_prefix + "[CONTRIBUTING](https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md) checklist issues resolved.\n\n";
Copy link
Member

@bsdimp bsdimp Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here...

});
}
Loading