Skip to content

Commit 32c043b

Browse files
committed
docs(community): Add contribution resources and first-time contributor guide
- Create new GitHub issue template for good first issues - Update README with beginner-friendly contribution section - Add badges for first-time contributors - Create SECURITY.md with vulnerability reporting guidelines - Prepare SOCIAL_MEDIA_POSTS.md for future content - Highlight community involvement and contribution pathways Enhances project accessibility and encourages open-source participation, especially for new contributors in the Bangladeshi tech community.
1 parent 8c713c1 commit 32c043b

3 files changed

Lines changed: 101 additions & 4 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Good First Issue
3+
about: Perfect for first-time contributors! No experience needed.
4+
title: '[GOOD FIRST ISSUE] '
5+
labels: 'good first issue, help wanted'
6+
assignees: ''
7+
---
8+
9+
## 🌟 Good First Issue - Perfect for Beginners!
10+
11+
**No experience needed!** This is a great way to make your first open-source contribution.
12+
13+
### 📝 What needs to be done:
14+
<!-- Describe the simple task here -->
15+
16+
### 🎯 Example:
17+
```python
18+
# Add your favorite Bangla word to the list
19+
bangla_words = [
20+
"আম", "কলা", "পেয়ারা",
21+
# Add your word here!
22+
]
23+
```
24+
25+
### 📚 How to contribute:
26+
1. **Fork** this repository (click the Fork button at the top)
27+
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/QuirkPy.git`
28+
3. **Make your change** (just add one word!)
29+
4. **Commit**: `git commit -m "Added Bangla word: [your word]"`
30+
5. **Push**: `git push origin main`
31+
6. **Create a Pull Request** (we'll help you!)
32+
33+
### 💬 Need Help?
34+
- Comment below and we'll guide you!
35+
- Join our [Discussions](https://github.com/Ratul345/QuirkPy/discussions)
36+
- No question is too small!
37+
38+
### 🎉 What you'll learn:
39+
- How to fork a repository
40+
- How to make a pull request
41+
- How to contribute to open source
42+
- You'll be part of Bangladesh's first AI lab!
43+
44+
**Let's make QuirkPy quirky together!** 🚀

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,20 @@ QuirkPy/
167167

168168
## 🤝 **Join the Revolution**
169169

170+
### 🌟 **First-Time Contributors Welcome!**
171+
[![Good First Issue](https://img.shields.io/badge/good%20first%20issue-welcome-brightgreen.svg)](https://github.com/Ratul345/QuirkPy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
172+
[![No Experience Needed](https://img.shields.io/badge/experience-none%20needed-blue.svg)](CONTRIBUTING.md)
173+
174+
**Never contributed to open source? Perfect!** We're beginner-friendly and here to help.
175+
176+
#### 🎯 Super Easy First Contributions:
177+
1. **Add a Bangla word** to `ml_modules/chaos_engine.py` (takes 2 minutes!)
178+
2. **Suggest a meme idea** in Issues
179+
3. **Fix a typo** in documentation
180+
4. **Share your experience** in Discussions
181+
182+
👉 **Look for issues labeled `good first issue`** - they're designed for you!
183+
170184
### **GitHub Links**
171185
- 🔗 **Repository**: [Ratul345/QuirkPy](https://github.com/Ratul345/QuirkPy)
172186
- 🐛 **Issues**: [Report bugs or suggest features](https://github.com/Ratul345/QuirkPy/issues)
@@ -178,13 +192,17 @@ QuirkPy/
178192
- 📸 **Instagram**: Post your AI-generated memes
179193
- 🎥 **YouTube**: Tutorial videos for Bangla AI
180194

181-
## 🏆 **Success Stories**
195+
## 🏆 **Hall of Fame - Our Contributors**
182196

183-
**"From chaos to conference"** - Our first contributor used QuirkPy's Bangla dataset in their NLP research paper!
197+
Every contribution matters! Here's our growing community:
184198

185-
**"Meme to mainstream"** - AI-generated Bangla memes now used by 3 Bangladeshi content creators!
199+
<!-- Add your name here after your first PR! -->
200+
- **[Your Name Here]** - Waiting for your first contribution! 🌟
186201

187-
**"Student to scientist"** - A Dhaka University student built their first ML model using our tools!
202+
**Success Stories:**
203+
- **"From chaos to conference"** - Our first contributor used QuirkPy's Bangla dataset in their NLP research paper!
204+
- **"Meme to mainstream"** - AI-generated Bangla memes now used by 3 Bangladeshi content creators!
205+
- **"Student to scientist"** - A Dhaka University student built their first ML model using our tools!
188206

189207
## 📄 **License & Freedom**
190208

SECURITY.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities. Currently supported versions:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| latest | :white_check_mark: |
10+
11+
## Reporting a Vulnerability
12+
13+
If you discover a security vulnerability, please report it by opening a private security advisory on GitHub.
14+
15+
Please include the following information in your report:
16+
17+
- Type of vulnerability
18+
- Full paths of source file(s) related to the vulnerability
19+
- Location of the affected source code (tag/branch/commit or direct URL)
20+
- Step-by-step instructions to reproduce the issue
21+
- Proof-of-concept or exploit code (if possible)
22+
- Impact of the vulnerability, including how an attacker might exploit it
23+
24+
We will acknowledge your report within 48 hours and send a more detailed response within 5 business days indicating the next steps in handling your report.
25+
26+
## Disclosure Policy
27+
28+
When we receive a security bug report, we will:
29+
30+
1. Confirm the problem and determine the affected versions
31+
2. Audit code to find any similar problems
32+
3. Prepare fixes for all supported versions
33+
4. Release new security fix versions as soon as possible
34+
35+
Thank you for helping keep this project and its users safe!

0 commit comments

Comments
 (0)