FLOW MASTER
Flow Master
Seiten · Flow Master

Development Setup

This guide helps developers set up their environment for contributing to Flow Master or building custom extensions.

Table of Contents

Prerequisites

Required Software

text

Platform-Specific Requirements

Windows Development

bash

macOS Development

bash

Linux Development

bash

IDE Setup

VS Code (Recommended)

json

Required VS Code Extensions

  • Dart: Dart language support
  • Flutter: Flutter framework support
  • GitLens: Enhanced Git capabilities
  • Error Lens: Inline error display

Environment Setup

Clone Repository

bash

Install Dependencies

bash

Generate Code

bash

Environment Configuration

bash

Project Structure

Directory Layout

text

Key Files

  • pubspec.yaml: Project dependencies and configuration
  • analysis_options.yaml: Code analysis rules
  • .github/: CI/CD workflows and templates
  • build_runner.yaml: Code generation configuration

Building and Running

Development Build

bash

Release Build

bash

Debug Build with Profiling

bash

Development Workflow

Branch Strategy

text

Feature Development

bash

Code Style

Follow these conventions:

  • Dart Style Guide: Official Dart style conventions
  • File Naming: Use snake_case for files
  • Class Naming: Use PascalCase for classes
  • Variable Naming: Use camelCase for variables
  • Constants: Use SCREAMING_SNAKE_CASE

Commit Messages

Use conventional commit format:

text

Testing

Test Structure

text

Running Tests

bash

Writing Tests

dart

Test Guidelines

  • Write Tests First: TDD approach recommended
  • Test Edge Cases: Include boundary conditions
  • Mock Dependencies: Use mocks for external services
  • Clear Test Names: Describe what is being tested
  • Setup/Teardown: Clean state between tests

Contributing

Code Review Process

  1. Create Feature Branch: From develop branch
  2. Implement Feature: With tests and documentation
  3. Run Tests: Ensure all tests pass
  4. Submit PR: With clear description and screenshots
  5. Address Feedback: Respond to review comments
  6. Merge: After approval from maintainers

Quality Checklist

Before submitting:

  • Code follows style guidelines
  • All tests pass
  • No lint warnings
  • Documentation updated
  • Screenshots for UI changes
  • Performance impact considered

Getting Help

  • Discord: Join developer channel for real-time help
  • GitHub Issues: Search existing issues first
  • Documentation: Check docs for common questions
  • Code Comments: Read inline documentation

Development Tools

Useful Commands

bash

VS Code Shortcuts

  • Ctrl+Shift+P: Command palette
  • F5: Start debugging
  • Ctrl+F5: Run without debugging
  • Ctrl+Shift+R: Hot reload
  • Ctrl+.: Quick fix

Performance Profiling

bash

Debugging

dart

This setup guide should get you ready for Flow Master development. For additional help, check the other documentation files or reach out to the development team.