Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (48 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

73 lines (48 loc) · 1.69 KB
Raw

Contributing to Flunner

Thank you for your interest in contributing to Flunner! We welcome contributions ranging from bug reports and documentation fixes to feature proposals and code contributions.

Code of Conduct

All contributors are expected to adhere to our Code of Conduct. Please be kind, respectful, and constructive in all interactions.

Development Setup

Prerequisites

  • Flutter SDK: 3.47+
  • Dart SDK: 3.13+ (bundled with Flutter)
  • Desktop toolchain for your target platform:
    • macOS: Xcode / macOS desktop embedder
    • Linux: clang, cmake, ninja-build, GTK dev packages
    • Windows: Visual Studio with Desktop development workload

Building the Project

  1. Clone your fork locally:

    git clone https://github.com/<your-username>/flunner-flutter.git
cd flunner-flutter

  2. Install dependencies:

    flutter pub get

  3. Run static analysis and tests:

    flutter analyze
flutter test

  4. Launch the app:

    flutter run -d macos   # or linux / windows

Pull Request Process

  1. Fork the repo and create a feature branch (git checkout -b feature/amazing-feature)
  2. Commit your changes with clear messages
  3. Ensure flutter analyze and flutter test pass
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request against main

Reporting Issues

Please search existing issues before opening a new one. Include:

  • Flutter/Dart version (flutter --version)
  • Target platform (macOS, Linux, Windows)
  • Steps to reproduce
  • Expected vs actual behavior

For security issues, see SECURITY.md.