-
Notifications
You must be signed in to change notification settings - Fork 3.6k
[google_fonts] Improve CONTRIBUTING and generator README #9917
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request consolidates and improves the documentation for the google_fonts package generator. It achieves this by removing the package-level CONTRIBUTING.md and moving its contents into an expanded generator/README.md. The changes make the instructions for running the generator clearer and more discoverable. I've provided a couple of suggestions to further improve the wording and fix a broken link in the new README file.
|
exempted from CHANGELOG update and version change: local development |
| regenerate most Dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). | ||
|
|
||
| 1. Navigate to the root directory of this project. | ||
| Note: Googlers only, pending b/280786655, there is an additional prerequisite step required of the Google Fonts team |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is this additional step documented?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it is, just something I know. In the status update, there's a link to a manual version of the process, the long term idea being to remove the need for this. The bug assignee has all the info
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure I follow. So when we go to run the generator script, we contact the assigned person on that bug to complete another step first?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right. So, the generator looks for the latest directory of fonts. New versions of that directory are created (currently, with a manual step) by that Googler.
stuartmorgan-g
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with one nit.
Piinks
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
flutter/packages@98580c6...cab2ac2 2025-09-05 [email protected] Roll Flutter from 6b18740 to 87d5b75 (88 revisions) (flutter/packages#9962) 2025-09-04 [email protected] [google_fonts] Improve CONTRIBUTING and generator README (flutter/packages#9917) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
flutter/packages@98580c6...cab2ac2 2025-09-05 [email protected] Roll Flutter from 6b18740 to 87d5b75 (88 revisions) (flutter/packages#9962) 2025-09-04 [email protected] [google_fonts] Improve CONTRIBUTING and generator README (flutter/packages#9917) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
flutter/packages@98580c6...cab2ac2 2025-09-05 [email protected] Roll Flutter from 6b18740 to 87d5b75 (88 revisions) (flutter/packages#9962) 2025-09-04 [email protected] [google_fonts] Improve CONTRIBUTING and generator README (flutter/packages#9917) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Apply feedback from flutter#9895 Note: the `families_diff` file created by the generator should suffice in writing CHANGELOG updates ## Pre-Review Checklist **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
flutter/packages@98580c6...cab2ac2 2025-09-05 [email protected] Roll Flutter from 6b18740 to 87d5b75 (88 revisions) (flutter/packages#9962) 2025-09-04 [email protected] [google_fonts] Improve CONTRIBUTING and generator README (flutter/packages#9917) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Apply feedback from #9895
Note: the
families_difffile created by the generator should suffice in writing CHANGELOG updatesPre-Review Checklist
[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under1.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under1.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2 ↩3