Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated CONTRIBUTING.md for to add well known errors #377

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ you can do that and all these approaches can be found at [TaskWarrior-Flutter](h
1. Clone the repository from GitHub:

```bash
git clone https://github.com/CCExtractor/taskwarrior-flutter.git
git clone https://github.com/CCExtractor/taskwarrior-flutter.git taskwarrior_flutter
```

2. Navigate to project's root directory:

```bash
cd taskwarrior-flutter
cd taskwarrior_flutter
```

3. Check for Flutter setup and connected devices:
Expand Down Expand Up @@ -66,3 +66,27 @@ ___
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request in the **develop branch**

### Common Issues to Note
- Linux Compatibility Error
If you encounter the following error when building the app on Linux, it is related to a missing type `UnmodifiableUint8ListView`. This issue can often occur during the build process:
```sh
Building package executables... (5.4s)
Failed to build get_cli:get:
../../../.pub-cache/hosted/pub.dev/win32-5.3.0/lib/src/guid.dart:32:9: Error: Type 'UnmodifiableUint8ListView' not found.
final UnmodifiableUint8ListView bytes;
^^^^^^^^^^^^^^^^^^^^^^^^^
```
solution:
```sh
flutter pub cache clean
flutter channel stable
flutter pub get
```
follow this thread for the discussion on it: [solution](https://github.com/jonataslaw/get_cli/issues/263)

- Android Debug Naming Format Issue
Flutter does not support repository names with dashes when setting up Android debug mode. To avoid errors, clone the repository using an underscore in the name:
```sh
git clone https://github.com/CCExtractor/taskwarrior-flutter taskwarrior_flutter
```