Skip to content

Commit 696cc6a

Browse files
Update documentation links and enhance contribution guide
1 parent fd1a11c commit 696cc6a

File tree

2 files changed

+99
-4
lines changed

2 files changed

+99
-4
lines changed

CONTRIBUTING.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,98 @@ Thanks for considering contributing!
1313
2. Create a new branch
1414
3. Make your changes
1515
4. Submit a Pull Request
16+
17+
# 🤝 Contribute to WebDev Power Kit
18+
19+
Welcome to the official contribution guide for **WebDev Power Kit** — a modular, TypeScript-powered toolkit for modern web developers. Whether you’re a beginner or an experienced dev, we’d love your input. 💡
20+
21+
---
22+
23+
## 🧠 Why Contribute?
24+
25+
WebDev Power Kit helps simplify common browser tasks and utility features. By contributing:
26+
27+
* You help build a stronger dev toolkit for everyone 🔧
28+
* You get your name featured in a fast-growing OSS project 🏆
29+
* You gain open-source experience for your resume 💼
30+
31+
---
32+
33+
## 🚀 Available Contribution Options
34+
35+
You can contribute in multiple ways:
36+
37+
| Type | Description |
38+
| ---------------------------- | ----------------------------------------- |
39+
| 🐞 Bug Report | Found something broken? Report it here |
40+
| 🚀 Feature Request | Suggest a new browser/utility feature |
41+
| 💬 Question / Help | Ask about usage, setup, or best practices |
42+
| 🧰 Custom Utility Suggestion | Recommend a reusable utility function |
43+
44+
---
45+
46+
## 📝 Templates for Issues
47+
48+
We’ve created pre-filled GitHub issue templates so it’s super easy to contribute:
49+
50+
### 🚀 Feature Request
51+
52+
Suggest a new feature with:
53+
54+
* What it should do
55+
* Why it’s useful
56+
* What category it belongs to
57+
58+
📩 [Submit Feature Request](https://github.com/dev-aditya-lab/webdev-power-kit/issues/new?template=feature_request.yml)
59+
60+
---
61+
62+
### 🐞 Bug Report
63+
64+
If something isn't working:
65+
66+
* Describe what happened
67+
* Share what you expected
68+
* Mention browser/version/module
69+
70+
📩 [Report a Bug](https://github.com/dev-aditya-lab/webdev-power-kit/issues/new?template=bug_report.yml)
71+
72+
---
73+
74+
### 💬 Ask a Question
75+
76+
Need help understanding a feature or usage?
77+
78+
* Ask your question
79+
* Mention what you’ve already tried
80+
81+
📩 [Ask a Question](https://github.com/dev-aditya-lab/webdev-power-kit/issues/new?template=question.yml)
82+
83+
84+
---
85+
86+
## 🛠 Tips for Developers
87+
88+
If you're planning to contribute code:
89+
90+
* Follow the **modular structure**: each feature in its own folder with `index.ts`
91+
* Use **TypeScript** and include **error handling**
92+
* Add **JSDoc comments**
93+
* Keep it framework-agnostic (React examples only in docs)
94+
95+
📦 All exported files should go through `/src/` and use clear file names.
96+
97+
---
98+
99+
## 🙌 Thank You!
100+
101+
Every suggestion, report, or idea helps make WebDev Power Kit better for everyone.
102+
Let’s build a toolkit devs love to use. ❤️
103+
104+
> 💬 For any private requests or collaboration, feel free to reach out on [GitHub Discussions](https://github.com/dev-aditya-lab/webdev-power-kit/discussions)
105+
106+
📢 **Star the repo** if you like it → [GitHub Repo](https://github.com/dev-aditya-lab/webdev-power-kit)
107+
108+
---
109+
110+
Made with 💻 by Aditya Kumar Gupta

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Write clean, future-ready web apps with ease using modern browser features in ju
4444

4545
Explore detailed guides, feature docs, and examples in the docs section:
4646

47-
👉 [View Full Documentation](https://webdev-power-kit.hashnode.dev/docs/introduction)
47+
👉 [View Full Documentation](https://webdev-power-kit.hashnode.space/docs/introduction)
4848

4949
**Structure Includes:**
5050

@@ -154,9 +154,9 @@ We follow a clean modular structure — every feature must:
154154
**Aditya Kumar Gupta**
155155
Computer Science Engineer • Web Developer • Hackathon Enthusiast
156156

157-
* 🔗 [Portfolio](https://your-portfolio-link)
158-
* 🐙 [GitHub](https://github.com/adityakgupta)
159-
* 📝 [Hashnode Docs](https://webdev-power-kit.hashnode.dev/docs/introduction)
157+
<!-- * 🔗 [Portfolio](https://your-portfolio-link) -->
158+
* 🐙 [GitHub](https://github.com/dev-aditya-lab)
159+
* 📝 [Hashnode Docs](https://webdev-power-kit.hashnode.space/docs/introduction)
160160

161161
---
162162

0 commit comments

Comments
 (0)