Skip to content

Contributing

We welcome contributions to Openza Flow! Here’s how to get started.

Getting Started

  1. Fork the repository on GitHub

  2. Clone your fork

    Terminal window
    git clone https://github.com/YOUR_USERNAME/flow.git
    cd flow
  3. Create a branch

    Terminal window
    git checkout -b feature/your-feature-name
  4. Make your changes following our coding standards

  5. Test your changes

    Terminal window
    flutter test
    flutter analyze
  6. Submit a pull request

Coding Standards

  • Follow the Dart Style Guide
  • Use flutter analyze to check for issues
  • Write tests for new features
  • Keep commits atomic and well-described

Pull Request Guidelines

  • Describe what your PR does and why
  • Include screenshots for UI changes
  • Ensure all tests pass
  • Keep PRs focused on a single feature or fix

Areas to Contribute

  • Bug fixes - Check the issues for reported bugs
  • New features - Discuss in an issue first
  • Documentation - Help improve these docs
  • Tests - Increase test coverage
  • Translations - Add new language support

Reporting Issues

Found a bug? Have a feature request?

  1. Search existing issues first
  2. If not found, create a new issue with:
    • Clear description
    • Steps to reproduce (for bugs)
    • Expected vs actual behavior
    • System information

License

By contributing, you agree that your contributions will be licensed under the MIT License.