Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (54 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

69 lines (54 loc) · 1.61 KB

Contributing to creating-clean-flutter

Thanks for your interest in contributing! 🎉

How to Contribute

Reporting Issues

If you find a bug or have a suggestion:

  1. Check if the issue already exists
  2. Create a new issue with a clear description
  3. Include steps to reproduce (for bugs)
  4. Mention your Flutter and Python versions

Pull Requests

  1. Fork the repository

  2. Create a feature branch

    git checkout -b feature/your-feature-name

  3. Make your changes

    • Keep changes focused and minimal
    • Follow the existing code style
    • Test your changes thoroughly

  4. Test the skill

    python3 clean_flutter.py test_app --platforms android,ios
cd test_app
flutter analyze
flutter test

  5. Commit your changes

    git commit -m "Add: brief description of your changes"

  6. Push and create PR

    git push origin feature/your-feature-name

Development Guidelines

Code Style

  • Follow PEP 8 for Python code
  • Use clear, descriptive variable names
  • Add comments for complex logic only

Testing

Before submitting a PR, ensure:

  • The script runs without errors
  • Generated projects pass flutter analyze
  • Generated projects pass flutter test
  • All files are properly formatted
  • No sensitive information is included

Commit Messages

Use clear, descriptive commit messages:

  • ✅ Good: "Add support for web platform"
  • ✅ Good: "Fix pubspec.yaml comment removal"
  • ❌ Bad: "update code"
  • ❌ Bad: "fix stuff"

Questions?

Feel free to open an issue for questions or discussions!