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

Maintanence: Update README.md to improve DX #285

Merged

Conversation

salihgueler
Copy link
Contributor

Description

Updates the README.md files to fix some problems explained at issue #284

Related Issues

#284

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes tests for all changed/updated/fixed behaviors.
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • The package compiles with the minimum Flutter version stated in the pubspec.yaml

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

Copy link
Collaborator

@TahaTesser TahaTesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this looks like a idea to me but I'll let @ulusoyca review as I mainly review code format and tests here.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@ulusoyca
Copy link
Collaborator

ulusoyca commented Aug 1, 2024

Thanks for this amazing work! Added some suggestions!

@ulusoyca ulusoyca enabled auto-merge August 5, 2024 19:13
@ulusoyca ulusoyca requested review from TahaTesser and removed request for TahaTesser August 5, 2024 19:14
@ulusoyca ulusoyca merged commit 29d8e8a into woltapp:main Aug 5, 2024
3 checks passed
@salihgueler salihgueler deleted the maintanence/update_readme_and_samples branch August 5, 2024 19:15
@ulusoyca ulusoyca self-requested a review August 5, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants