Skip to content

Commit 3cef723

Browse files
committed
Add welcome workflow for first-time contributors
Add .github/workflows/congratulations.yml: a GitHub Actions workflow that greets first-time contributors. It triggers on newly opened issues and pull requests to the develop branch, grants write permissions for issues and pull-requests, and runs actions/first-interaction@v3 to post tailored welcome messages and PR checklist guidance. The job runs on ubuntu-latest and provides tips and links to CONTRIBUTING, CODE_OF_CONDUCT, and README to help onboard new contributors.
1 parent 9b7a0fd commit 3cef723

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Congratulations
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
pull_request:
8+
branches:
9+
- develop
10+
types:
11+
- opened
12+
13+
permissions:
14+
issues: write
15+
pull-requests: write
16+
17+
jobs:
18+
Congratulation:
19+
name: Congratulations
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- uses: actions/first-interaction@v3
24+
with:
25+
repo_token: ${{ secrets.GITHUB_TOKEN }}
26+
issue_message: |
27+
# 🎉 Welcome to the Community!
28+
29+
Thank you for opening your **first issue** in this repository! We truly appreciate you taking the time to share your thoughts with us.
30+
31+
## ⏳ What Happens Next?
32+
33+
- A maintainer will review your issue as soon as possible
34+
- You may receive follow-up questions for clarification
35+
- Please be patient — we're often managing multiple projects
36+
37+
## 💡 Tips for a Smooth Process
38+
39+
- **Be descriptive**: The more details you provide, the faster we can help
40+
- **Include examples**: Screenshots, error logs, or code snippets are incredibly helpful
41+
- **Check existing issues**: Your question might already be answered somewhere
42+
- **Stay engaged**: Respond to any questions or requests for more information
43+
44+
## 📚 Helpful Resources
45+
46+
Please check the repository root for the following files (if available):
47+
- `CONTRIBUTING.md` — Guidelines for contributing
48+
- `CODE_OF_CONDUCT.md` — Community standards and expectations
49+
- `README.md` — Project documentation and getting started guide
50+
51+
---
52+
53+
> *We're excited to have you here! Every issue helps us improve.* 🚀
54+
55+
pr_message: |
56+
# 🎉 Welcome, Contributor!
57+
58+
Thank you for submitting your **first pull request** to this repository! We're thrilled to see your contribution.
59+
60+
## ⏳ What Happens Next?
61+
62+
- A maintainer will review your changes as soon as possible
63+
- You may receive feedback or requests for modifications
64+
- Once approved, your PR will be merged into the codebase
65+
66+
## ✅ PR Checklist
67+
68+
Before your PR can be merged, please ensure:
69+
70+
- [ ] Your code follows the project's coding style and conventions
71+
- [ ] You've tested your changes locally
72+
- [ ] You've updated relevant documentation (if applicable)
73+
- [ ] All CI checks are passing
74+
- [ ] Your commits have clear and meaningful messages
75+
76+
## 💡 Tips for Success
77+
78+
- **Keep it focused**: Smaller, focused PRs are easier to review
79+
- **Describe your changes**: Help reviewers understand what you did and why
80+
- **Be responsive**: Address feedback promptly to keep the review moving
81+
- **Ask questions**: Don't hesitate to ask if something is unclear
82+
83+
## 🔄 Need to Make Changes?
84+
85+
If you need to update your PR based on feedback:
86+
1. Make your changes locally
87+
2. Commit and push to the same branch
88+
3. The PR will automatically update
89+
90+
---
91+
92+
> *Your contribution makes this project better. Thank you for being part of our community!* 💜

0 commit comments

Comments
 (0)