Thank you for stopping by here! There are many ways to make Flow better for everyone. Here are few:
- Report a bug
- Propose a feature
- Contribute code
- Translating Flow to your own language
- Buy maintainer a coffee. Flow is a free and open-source software, and will stay this way.
NOTE: A quick discussion upfront can highlight any potential issues, streamline the merge process, and ensure you're on the right track to avoid rework.
TIP: Look for issues with ready label to get started without any friction
- Fork the repository
- Pick an issue. If the fix/feature you're gonna work doesn't have an issue, please create one first.
- Let everyone know that you're working on it by commenting "I'm working on it"
- Create a feature branch. For example, if you're working on
#82, create a branch
username/fix82(based ondevelop). The name can be different, doesn't matter. - Make changes on the new branch
- Ensure your code doesn't have any linter warnings, errors
(Your editor will tell you, or you can run
flutter analyze) - Submit a PR to
developbranch - If your feature involves UI changes, add a short video demonstrating the implement change/feature
- Please consider accessibility, localization, and technical factors before implementing a new feature
- Any new dependency must support the all the platforms except for Web
- It is not necessary to change the version unless you're in charge of publishing a release
- Update CHANGELOG.md with your change description. (Use
version name
next)
When translating Flow to your language, the translation coverage must be 100%. You can follow the same steps in Developing, and you can safely skip lints and tests (step 6 and 7).
It's highly recommended to copy en_US.json or any other existing translations with full coverage, and work on top of it.
Make sure you add the your language in the list of supported languages. See lib/l10n/supported_languages.dart.
By contributing, you agree that your contributions will be licensed under GNU GENERAL PUBLIC LICENSE v3