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

Update Contributing Documentation #374

Open
1 task done
rohansen856 opened this issue Nov 13, 2024 · 2 comments · May be fixed by #377
Open
1 task done

Update Contributing Documentation #374

rohansen856 opened this issue Nov 13, 2024 · 2 comments · May be fixed by #377
Assignees
Labels
enhancement New feature or request

Comments

@rohansen856
Copy link
Contributor

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:
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.

  1. 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:
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: [email protected]

Would you like to work on this issue?

Yes

By submitting this issue, I have confirmed that:

  • I have starred the repo ⭐ and watched 👀 it on GitHub and followed the contribution guidelines.
@rohansen856 rohansen856 added the enhancement New feature or request label Nov 13, 2024
@linuxcaffe
Copy link

First of all, taskwarrior-flutter looks great! I just installed it via GooglePlay, and I'm happy to see an active, good looking task client!

Secondly, I (linux user) followed the readme, cloned it, cd to the dir, and failed at "flutter pub get" with a "flutter: command not found".. and sure enough, I dug around and found no such executable! Huh? What am I missing? Thanks!

@rohansen856
Copy link
Contributor Author

@linuxcaffe It looks like your problem is with the flutter installation... Did you run flutter doctor and get expected result? If not, I think you might have to reinstall the flutter sdk.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants