Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (67 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

110 lines (67 loc) · 3.01 KB

Contributing to webdev-power-kit

Thanks for considering contributing!

Ways to help:

  • Fix bugs
  • Suggest improvements
  • Add more browser APIs
  • Improve docs

Steps:

  1. Fork the repo
  2. Create a new branch
  3. Make your changes
  4. Submit a Pull Request

🤝 Contribute to WebDev Power Kit

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. 💡

🧠 Why Contribute?

WebDev Power Kit helps simplify common browser tasks and utility features. By contributing:

  • You help build a stronger dev toolkit for everyone 🔧
  • You get your name featured in a fast-growing OSS project 🏆
  • You gain open-source experience for your resume 💼

🚀 Available Contribution Options

You can contribute in multiple ways:

Type Description
🐞 Bug Report Found something broken? Report it here
🚀 Feature Request Suggest a new browser/utility feature
💬 Question / Help Ask about usage, setup, or best practices
🧰 Custom Utility Suggestion Recommend a reusable utility function

📝 Templates for Issues

We’ve created pre-filled GitHub issue templates so it’s super easy to contribute:

🚀 Feature Request

Suggest a new feature with:

  • What it should do
  • Why it’s useful
  • What category it belongs to

📩 Submit Feature Request

🐞 Bug Report

If something isn't working:

  • Describe what happened
  • Share what you expected
  • Mention browser/version/module

📩 Report a Bug

💬 Ask a Question

Need help understanding a feature or usage?

  • Ask your question
  • Mention what you’ve already tried

📩 Ask a Question

🛠 Tips for Developers

If you're planning to contribute code:

  • Follow the modular structure: each feature in its own folder with index.ts
  • Use TypeScript and include error handling
  • Add JSDoc comments
  • Keep it framework-agnostic (React examples only in docs)

📦 All exported files should go through /src/ and use clear file names.

🙌 Thank You!

Every suggestion, report, or idea helps make WebDev Power Kit better for everyone. Let’s build a toolkit devs love to use. ❤️

💬 For any private requests or collaboration, feel free to reach out on GitHub Discussions

📢 Star the repo if you like it → GitHub Repo

Made with 💻 by Aditya Kumar Gupta