Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (54 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 2.18 KB
Raw

Contributing

Thanks for working on Flow Read.

Issue-Only Policy

This project currently accepts contributions through GitHub Issues only. Pull requests are disabled and are not accepted.

Use issues to report bugs, request features, propose changes, or share implementation notes. Please include enough context for maintainers to reproduce or evaluate the request.

Setup

Flow Read is a Flutter app pinned by .fvmrc. Prefer FVM:

fvm flutter pub get
fvm dart run tool/run_app.dart

The run tool selects the macOS or Windows desktop device for the current host. Windows does not require make. If FVM is unavailable, use a local Flutter SDK that matches .fvmrc and run dart run tool/run_app.dart.

Checks

Use focused checks while developing, then run broader checks before sharing local implementation notes in an issue:

fvm dart analyze
fvm flutter test
git diff --check

For release work, use the release tool:

dart run tool/release.dart current
dart run tool/release.dart check
dart run tool/release.dart package-local

package-local selects the current host platform. It produces a macOS app zip on macOS or a self-contained Windows x64 zip containing FlowRead.exe on Windows.

When updating assets/brand/flow_read_logo.png, regenerate the macOS app switcher icon before sharing changes:

dart run tool/sync_macos_app_icon.dart --fix
dart run tool/sync_macos_app_icon.dart --check

Do not bump versions unless the change is explicitly a release/version update.

Private Notes And Secrets

  • Keep internal planning documents under private/.
  • private/ is ignored by Git and should not be force-added.
  • Do not commit API keys, logs, backup files, imported books, or .env files.
  • Run gitleaks before publishing public branches or release tags.

Development Guidelines

  • Keep changes scoped to the active feature or bug.
  • Preserve the local-first data model.
  • Preserve Hive schema and migration compatibility.
  • Keep AI provider configuration user-controlled.
  • Keep online dictionary sources optional with local fallback.
  • Prefer focused tests for parser, storage, settings, backup, dictionary, RSS, reader, and release behavior.