Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (38 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 1.61 KB

Contributing to Flutter Modern Template

Thank you for considering contributing to Flutter Modern Template! 🎉

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue using the bug report template
  3. Provide as much detail as possible

Suggesting Features

  1. Check if the feature has already been suggested
  2. Create a new issue using the feature request template
  3. Explain the use case and benefits

Code Contributions

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes following our coding standards
  4. Test your changes thoroughly
  5. Commit with clear messages: git commit -m "Add: your feature description"
  6. Push to your fork: git push origin feature/your-feature-name
  7. Create a Pull Request

Coding Standards

Flutter/Dart

  • Follow Dart style guide
  • Use flutter analyze to check for issues
  • Format code with dart format
  • Add comments for complex logic

Commit Messages

  • Use present tense: "Add feature" not "Added feature"
  • Use imperative mood: "Move cursor to..." not "Moves cursor to..."
  • Limit first line to 72 characters
  • Reference issues: "Fix #123: resolve login bug"

Development Setup

  1. Clone your fork
  2. Run flutter pub get
  3. Run flutter analyze to check for issues
  4. Run flutter test to run tests
  5. Run flutter run to test the app

Questions?

Feel free to open an issue for any questions about contributing!