Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (76 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

109 lines (76 loc) · 2.57 KB

Contributing to React Starter CLI

Thank you for your interest in contributing to React Starter CLI! We welcome contributions from the community.

🚀 How to Contribute

Reporting Issues

  • Use the GitHub issue tracker to report bugs
  • Include detailed reproduction steps
  • Provide system information (OS, Node version, package manager)

Suggesting Features

  • Open an issue with the "enhancement" label
  • Describe the feature and its use case
  • Discuss the implementation approach

Code Contributions

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/react-starter-cli.git
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Test locally: npm start

Making Changes

  1. Create a feature branch: git checkout -b feature/your-feature-name
  2. Make your changes
  3. Test thoroughly
  4. Commit with descriptive messages
  5. Push to your fork
  6. Create a Pull Request

Code Style

  • Follow existing TypeScript/JavaScript conventions
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Ensure type safety

Testing

  • Test your changes with different frameworks (React, Vite, Next.js)
  • Test with different CSS frameworks
  • Test with different package managers (npm, yarn, pnpm)
  • Verify error handling and edge cases

🎯 Areas for Contribution

High Priority

  • New framework support (Remix, Svelte, etc.)
  • Additional CSS framework integrations
  • More optional package presets
  • Performance improvements

Medium Priority

  • Better error messages
  • Additional CLI options
  • Documentation improvements
  • Test coverage

Low Priority

  • UI/UX enhancements
  • Additional examples
  • Blog posts and tutorials

📝 Commit Convention

Use conventional commits for better changelog generation:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Test additions
  • chore: Maintenance tasks

Example: feat: add support for Remix framework

🔍 Pull Request Process

  1. Ensure your PR has a clear title and description
  2. Link any related issues
  3. Ensure all tests pass
  4. Update documentation if needed
  5. Request review from maintainers

📄 Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help others learn and grow
  • Maintain a positive community environment

🆘 Getting Help

  • Check existing issues for similar problems
  • Join discussions in GitHub Issues
  • Tag maintainers for urgent issues

Thanks for contributing! 🎉