CCExtractor / CCExtractor/taskwarrior-flutter

Update Contributing Documentation

Open
#374 2 comments 0 reactions 1 assignee Claimed by @rohansen856 View on GitHub
enhancement
Dominant language
Dart
Stars
244
Forks
179
Avg merge
12h 42m
Merged PRs (30d)
2

Description

### Describe your improvement idea or feature request

To improve the contributor experience, especially for Linux users and those setting up Android debugging, we propose updates to the contributing documentation to address common issues. Specifically:

Linux Build Error: Provide troubleshooting guidance for an error related to UnmodifiableUint8ListView, which often appears during Linux builds. Detailed instructions or a known workaround would be beneficial for users encountering this issue.

Android Debug Naming Format: Since Flutter does not support repository names with dashes for Android debug mode setup, we suggest including a note in the documentation. A recommended command for cloning with underscores in the folder name will help avoid setup errors.

These updates will improve the accessibility and usability of the repository for new contributors, creating a smoother onboarding process.

### How would you like to see it implemented?

There are currently several issues that may hinder contributors, especially those using Linux. A few key areas for improvement in the contributing documentation could help address these common issues:

1. Linux Compatibility Error
When building the project on Linux, the following error often occurs:
```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;
^^^^^^^^^^^^^^^^^^^^^^^^^
```
As there is no clear explanations present, Adding specific troubleshooting steps or workarounds for this error would greatly assist new contributors.

2. Android Debug Mode Setup Issue
Flutter does not support repository names with dashes in this context, causing issues when setting up Android debug mode. Changing the naming format by replacing the dash with an underscore could resolve this issue. Here’s an example command for clarity:
```sh
git clone https://github.com/CCExtractor/taskwarrior-flutter taskwarrior_flutter
```
Including this instruction in the contributing documentation would prevent setup issues for developers working with Android.

A comprehensive update to the contributing documentation addressing these points would be beneficial for enhancing accessibility and improving the onboarding process for new contributors. Thank you!

### Put here any screenshots or videos (optional)

_No response_

### How can we contact you (optional)

email me at: rohansen856@gmail.com

### Would you like to work on this issue?

Yes

### By submitting this issue, I have confirmed that:

- [X] I have starred the repo ⭐ and watched 👀 it on GitHub and followed the contribution guidelines.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.