Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (73 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

110 lines (73 loc) · 1.92 KB

🤝 Contributing to Quick Form Builder

Thank you for your interest in contributing to Quick Form Builder 🎉
All contributions — bug reports, feature requests, documentation, and code — are welcome.

📌 Before You Start

  • Make sure you’re using Node.js 24+
  • Familiarity with Next.js, TypeScript, and Prisma is helpful
  • Please search existing issues before opening a new one

🐛 Reporting Bugs

If you find a bug:

  1. Check existing issues
  2. Open a new issue with:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots/logs if applicable

💡 Feature Requests

Have an idea?

  • Open an issue with the label feature request
  • Explain the problem it solves
  • Keep it focused and actionable

🛠️ Development Setup

git clone https://github.com/Devsethi3/Quick-Form-Builder.git
cd Quick-Form-Builder
npm install
npm run dev

🔀 Pull Request Guidelines

  1. Fork the repository

  2. Create a feature branch:

    git checkout -b feature/your-feature-name

  3. Make your changes

  4. Ensure the app builds and runs

  5. Commit with a clear message:

    git commit -m "feat: add new form field type"

  6. Push to your fork

  7. Open a Pull Request

✅ Commit Message Convention

Use clear, semantic commits:

  • feat: new feature
  • fix: bug fix
  • chore: tooling / config
  • docs: documentation changes
  • refactor: code refactor

Example:

feat: add checkbox field support

🎨 Code Style

  • Use TypeScript strictly
  • Follow existing folder structure
  • Prefer reusable components
  • Keep UI changes responsive
  • Avoid unnecessary re-renders

🙏 Code of Conduct

Be respectful and constructive. Harassment or toxic behavior will not be tolerated.

❤️ Thank You

Every contribution makes this project better. We appreciate your time and effort 🚀