Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
89 lines (69 loc) · 2.31 KB

CONTRIBUTE.md

File metadata and controls

89 lines (69 loc) · 2.31 KB

Contributing to Next.js + Tailwind CSS Boilerplate

Thank you for considering contributing to this project! We welcome contributions from everyone.

🚀 Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/next-tw-boilerplate.git
cd next-tw-boilerplate
  3. Install dependencies using your preferred package manager: 
    npm install
# or yarn/pnpm/bun

🛠️ Development Workflow

  1. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

  2. Make your changes following the project conventions

  3. Test your changes by running:

    npm run dev
npm run build
npm run lint

  4. Commit your changes with a descriptive message:

    git add .
git commit -m "feat: add your feature description"
# or
git commit -m "fix: fix your bug description"

  5. Push to your fork and submit a pull request

📋 Contribution Guidelines

Code Style

  • Follow the existing code style (ESLint + Prettier are configured)
  • Use TypeScript for type safety
  • Follow React and Next.js best practices
  • Use Tailwind CSS for styling

Commit Messages

We follow conventional commits:

  • feat: - New features
  • fix: - Bug fixes
  • docs: - Documentation changes
  • style: - Code style changes (formatting, etc.)
  • refactor: - Code refactoring
  • test: - Adding or updating tests
  • chore: - Maintenance tasks

Pull Request Process

  1. Ensure your PR description clearly describes the problem and solution
  2. Reference any related issues in your PR description
  3. Make sure all checks pass (linting, building, etc.)
  4. Keep your PR focused - one feature/fix per PR
  5. Update documentation if needed

🐛 Reporting Bugs

  • Use the GitHub issue tracker
  • Include steps to reproduce the bug
  • Include browser and OS information
  • Include screenshots if applicable

💡 Suggesting Features

  • Use the GitHub issue tracker
  • Clearly describe the feature and its benefits
  • Provide use cases and examples if possible

❓ Questions?

Feel free to open an issue for questions or join discussions in existing issues.

Thank you for contributing! 🎉