Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (65 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 2.25 KB

Contributing to Create Next Quick

Thank you for your interest in contributing to Create Next Quick! Your contributions help make this project better for everyone.

How You Can Contribute

🚀 Reporting Bugs

  • Use the Issues tab to report bugs
  • Include your package version (npx create-next-quick --version)
  • Provide clear steps to reproduce, expected behavior, and screenshots if applicable
  • Share your environment details (Node.js and npm versions)

🛠️ Submitting Enhancements or Features

  • Open an issue first to discuss your idea
  • Please wait for approval before starting major work
  • Consider compatibility with different Next.js versions

🧪 Writing Tests

  • Add tests for new features or bug fixes
  • Ensure all tests pass before submitting a PR

Getting Started

1. Fork the Repository

Click the "Fork" button at the top right of the repo.

2. Clone Your Fork

git clone https://github.com/your-username/create-next-quick.git
cd create-next-quick

3. Development Setup

# Install dependencies
npm install

# Link package locally
npm link

# Test the package
npx create-next-quick my-app

Code Guidelines

  • Follow the existing TypeScript/JavaScript style
  • Use meaningful commit messages
  • Write clean, modular code
  • Update documentation for new features

Submitting a Pull Request

  1. Create a feature branch:
git checkout -b feature/your-feature-name
  1. Commit your changes:
git commit -m "feat: your feature description"
  1. Push to your fork and open a PR:
git push origin feature/your-feature-name

PR Checklist

  • Tests added/updated
  • Documentation updated
  • Code follows project style
  • All checks passing

Code of Conduct

Please review our Code of Conduct. By participating, you agree to abide by its terms.

Need Help?

If you have questions:

  • Open an issue in our repository
  • Use the discussions tab for general queries
  • Review existing issues and documentation

Happy coding! 🚀