Contributing

Thank you for your interest in contributing to Flowing Code's open source projects.

This section documents the conventions, practices, and guidelines we follow when developing and maintaining our add-ons and libraries. The same standards apply whether you are a member of the Flowing Code team or an external contributor.

Contents

• Code Style — Java formatting, JavaDoc conventions, and editor configuration.
• Conventional Commits — commit message format used across all repositories.
• AI Usage — how we expect AI tools to be used when contributing code, documentation, and reviews.

How to contribute

Each Flowing Code add-on and library lives in its own repository on the Flowing Code GitHub organization. To contribute:

1. Find the relevant repository. Each add-on documented in this site links to its source repository.
2. Open an issue first for non-trivial changes, so the change can be discussed before code is written.
3. Fork the repository, create a branch, and submit a pull request. Follow the code style and commit message conventions documented in this section.
4. Be responsive to review. PRs may receive feedback before being merged.

Reporting issues

File issues in the affected repository. A good bug report includes:

• The add-on or library version (and the Vaadin and Java versions in use).
• A minimal, self-contained reproduction.
• The observed behavior and the expected behavior.

Licensing

All Flowing Code open source projects are released under the Apache License 2.0 unless explicitly stated otherwise in the repository. By submitting a contribution you agree that it is licensed under the same terms.