|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +You can contribute to **Taskwarrior-Flutter** by: |
| 4 | + |
| 5 | +- Reporting issues or bugs you find. |
| 6 | +- Proposing improvements to the project. |
| 7 | +- Forking the repository, modifying the code, and creating a Pull Request (PR). |
| 8 | + |
| 9 | +Check [CONTRIBUTING.md](https://github.com/CCExtractor/taskwarrior-flutter/blob/main/CONTRIBUTING.md) for more details. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +## Commit conventions |
| 14 | + |
| 15 | +When opening PRs, **please specify the commit type** using the following conventions: |
| 16 | + |
| 17 | +| Type | Description | |
| 18 | +|------|-------------| |
| 19 | +| `feat` | A new feature you're proposing | |
| 20 | +| `fix` | A bug fix in the project | |
| 21 | +| `style` | UI/UX improvements or styling updates | |
| 22 | +| `test` | Testing-related updates | |
| 23 | +| `docs` | Documentation updates | |
| 24 | +| `refactor` | Code refactoring and maintenance | |
| 25 | + |
| 26 | +--- |
| 27 | + |
| 28 | +## Development Practices |
| 29 | + |
| 30 | +**Flutter Version** |
| 31 | + |
| 32 | +Use **Flutter 3.29.2** or later for development (documentation updated 23 Feb 2026): |
| 33 | +```text |
| 34 | +Flutter 3.29.2 • channel stable |
| 35 | +Framework • revision 90673a4eef • 2026-02-18 (framework revision date) |
| 36 | +Dart 3.7.2 • DevTools 2.42.3 • released 2025-03-12 |
| 37 | +``` |
| 38 | + |
| 39 | +**File Naming Convention** |
| 40 | + |
| 41 | +The project follows [snake_case](https://en.wikipedia.org/wiki/Snake_case) naming — this must be followed without fail. |
| 42 | + |
| 43 | +**Examples** : |
| 44 | +* File names : services_info.dart, dev_api_service.dart, home_view.dart |
| 45 | +* Folder names : api, disk_explorer, smart_widgets |
| 46 | + |
| 47 | +**UI/UX Constants** |
| 48 | + |
| 49 | +Colors, dimensions, and any UI constants must be defined in the respective theme file: |
| 50 | +`/lib/app/utils/themes/themes.dart` |
| 51 | + |
| 52 | +**Documentation** |
| 53 | + |
| 54 | +Document all functions, classes, and logic you implement. Follow the [Effective Dart Documentation](https://dart.dev/guides/language/effective-dart/documentation) guidelines without fail. |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Community |
| 59 | + |
| 60 | +Join the CCExtractor community on **Zulip** to propose improvements and connect with other contributors. |
| 61 | + |
| 62 | +- 💬 [Join CCExtractor on Zulip](https://ccextractor.org/public/general/support) |
0 commit comments