michael-hoke commented on issue #1374:
URL:
https://github.com/apache/daffodil-vscode/issues/1374#issuecomment-3215710086
PR Template starting point (this goes in .github/pull_request_template.md)
```
Closes #(issue)
## Description
Please include a summary of the change and which issue is fixed. Also
include relevant context or motivation.
## Wiki
- [ ] I have determined that no wiki updates are needed for these changes
- [ ] I have added documentation to the wiki for these changes
## Screenshots (if applicable)
Add screenshots or GIFs to help explain the change visually.
```
PR Workflow (for disallowing a merge if the checkbox isn't checked)
```
name: Enforce Wiki Checkbox
on:
pull_request:
types: [opened, edited, synchronize, reopened]
jobs:
enforce-checkbox:
runs-on: ubuntu-latest
steps:
- name: Check required confirmation checkbox
uses: actions/github-script@v7
with:
script: |
const prBody = context.payload.pull_request.body || "";
const checkbox1Text = "- [x] I have determined that no wiki
updates are needed for these changes";
const checkbox2Text = "- [x] I have added documentation to the
wiki for these changes";
if (!prBody.includes(checkbox1Text) &&
!prBody.includes(checkbox2Text) {
core.setFailed("❌ Required wiki checkbox not checked. Please
check the box before merging.");
} else {
core.info("✅ Required wiki checkbox is checked.");
}
```
Issue template (goes in a named file, maybe bug_report.md, under
.github/ISSUE_TEMPLATE/ ). We could have multiple, depending on the issue type.
We can also force the use of a template in a config.yml file, probably under
.github, with the blank_issues_enabled directive set to false.
```
## Description
A clear and concise description of what the bug is.
## Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. See error
## Expected behavior
What did you expect to happen?
## Actual behavior
What actually happened?
## Screenshots (optional)
## Environment
- OS:
- Browser/VS Code version:
- Extension version:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
