From 89c9fa323ba5e3eb2fabb65d2985f55b3e8db154 Mon Sep 17 00:00:00 2001 From: Amix Date: Thu, 9 Jul 2026 21:11:16 -0600 Subject: [PATCH] docs: align contributing guide with actual branch and Riverpod pattern (#461) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The repo has no `dev` branch (only `main` and l10n-related branches), and recent history shows PRs merge straight into `main` — update the fork/PR instructions to match. Also swap the Riverpod example for the hand-written `Notifier` pattern actually used across lib/providers/, since the codebase doesn't use riverpod_annotation code generation. --- CONTRIBUTING.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f4c5b26..0fdf455c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,10 +49,10 @@ Feature requests are welcome! Please use the feature request template and: ### Code Contributions -1. **Fork the repository** and create your branch from `dev` +1. **Fork the repository** and create your branch from `main` 2. **Make your changes** following our coding guidelines 3. **Test your changes** thoroughly -4. **Submit a pull request** to the `dev` branch +4. **Submit a pull request** to the `main` branch ### Translations @@ -172,17 +172,18 @@ flutter analyze ### State Management -We use **Riverpod** for state management. Follow these patterns: +We use **Riverpod** for state management, with hand-written `Notifier`s +(no `riverpod_annotation` code generation). Follow this pattern: ```dart -// Use code generation with riverpod_annotation -@riverpod -class MyNotifier extends _$MyNotifier { +class MyNotifier extends Notifier { @override MyState build() => MyState(); - + // Methods to update state } + +final myProvider = NotifierProvider(MyNotifier.new); ``` ### Localization @@ -238,7 +239,7 @@ chore(deps): update flutter_riverpod to 3.1.0 1. **Update your fork** ```bash git fetch upstream - git rebase upstream/dev + git rebase upstream/main ``` 2. **Create a feature branch** @@ -254,7 +255,7 @@ chore(deps): update flutter_riverpod to 3.1.0 ``` 5. **Create a Pull Request** - - Target the `dev` branch + - Target the `main` branch - Fill in the PR template - Link related issues