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 platform_specific_instructions.md: Add 'Why' explanations for better understanding #531

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

AffanShaikhsurab
Copy link
Contributor

Add explanations for platform-specific code to improve clarity for newcomers by detailing why the changes are necessary

PR Description

This PR enhances the platform_specific_instructions.md file by adding detailed explanations for platform-specific code changes. These explanations provide context on why certain modifications are required for macOS, Android, and Web platforms, helping newcomers understand the reasoning behind the code.

Changes Made:

  1. macOS: Added details on why entitlement keys are necessary to avoid network connection errors during app execution.
  2. Android: Explained the purpose of enabling multiDexEnabled in build.gradle to support apps with a large number of methods.
  3. Web: Provided an explanation for fixing the build error caused by the printing package, detailing the removal of .toJS for compatibility with the latest Dart runtime.

By adding these explanations, this PR ensures that new developers can better understand the purpose of platform-specific configurations and avoid common pitfalls during development.

  • Closes #

Checklist

  • [✔️ ] I have gone through the contributing guide
  • [ ✔️] I have updated my branch and synced it with project main branch before making this PR
  • [ ✔️] I am using the latest Flutter stable branch (run flutter upgrade and verify)
  • [✔️ ] I have run the tests (flutter test) and all tests are passing

Added/updated tests?

We encourage you to add relevant test cases.

  • Yes
  • [ ✔️] No, and this is why: This PR involves documentation updates only, which do not require test cases.

OS on which you have developed and tested the feature?

  • [ ✔️] Windows
  • [] macOS
  • [✔️ ] Linux

@ashitaprasad ashitaprasad merged commit 05b22f3 into foss42:main Jan 14, 2025
@ashitaprasad
Copy link
Member

Thanks for the PR.
Merged under issue #527

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.

2 participants