Add Automated Issue Comment on Issue Creation
Description
Set up a GitHub Actions workflow that automatically posts a welcome comment when a new issue is created. This guides contributors on the next steps after filing an issue.
What Needs to Be Done
- Create a new workflow file:
.github/workflows/issue-welcome.yml
- The workflow should trigger on
issues events (type: opened)
- Post an automated comment with:
- Thank you message
- Reminder to wait for issue assignment before starting work
- How to self-assign: comment
.take
- Link to contribution guidelines and code of conduct
- Note about DSCWoC program and scoring
Example Workflow
name: Issue Welcome Comment
on:
issues:
types: [opened]
jobs:
comment:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- uses: actions/github-script@v7
with:
script: |
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.payload.issue.number,
body: "Thank you for opening this issue!..."
});
Note: A .take workflow already exists at .github/workflows/take-issue.yaml for issue self-assignment. This new workflow complements it by providing guidance immediately when an issue is created.
Files to Create
.github/workflows/issue-welcome.yml
Acceptance Criteria
Add Automated Issue Comment on Issue Creation
Description
Set up a GitHub Actions workflow that automatically posts a welcome comment when a new issue is created. This guides contributors on the next steps after filing an issue.
What Needs to Be Done
.github/workflows/issue-welcome.ymlissuesevents (type:opened).takeExample Workflow
Note: A
.takeworkflow already exists at.github/workflows/take-issue.yamlfor issue self-assignment. This new workflow complements it by providing guidance immediately when an issue is created.Files to Create
.github/workflows/issue-welcome.ymlAcceptance Criteria