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

Add "check in pubspec.lock" advice to troubleshooting #262

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

bryanoltman
Copy link
Contributor

Adds advice to check in pubspec.lock in the native changes troubleshooting section.

@@ -237,6 +237,11 @@ This can be caused by a number of things. The most common causes are:
use caution when publishing patches that include changes to native code from
plugins. In the worst case, these changes may cause your patched app to
crash.**
:::tip
Add your `pubspec.lock` file to version control so you're always aware of
Copy link
Contributor

Choose a reason for hiding this comment

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

Dart has a great guide about the lock file, should we link it too?

https://dart.dev/guides/libraries/private-files#pubspec-lock

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If there were a Flutter-specific guide, I'd say yes. The dart guide is a little less clear/direct than I'd like (basically, I just want to tell users "Yes, check it in" rather than "don't check it in unless your package is an application package" and then having the users wonder what an application package is and whether their Flutter app is one of those, etc.). I'll copy some of the text from those docs over.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good, my suggestion was more in the lines that this guide corroborate for what we are suggesting the users.

But no strong opinions, the content is already good!

Copy link
Contributor

@erickzanardo erickzanardo left a comment

Choose a reason for hiding this comment

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

One suggestion, but looks great already!

@bryanoltman bryanoltman merged commit 1b0bc4c into main Jul 3, 2024
3 checks passed
@bryanoltman bryanoltman deleted the bo/native-change-tip branch July 3, 2024 14:04
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