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

INTL-1311:Add an explanatory comment on codemod-generated files #230

Merged
merged 3 commits into from
May 31, 2023

Conversation

alanknight-wk
Copy link
Contributor

Motivation

People aren't always clear on what's happening with the _intl.dart files and try to do normal code things that won't work, or want to apply formatting that won't be preserved. Add a comment at the beginning to try and clarify.

Changes

Adds a comment at the top of the generated code.

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

  • Tests were updated and provide good coverage of the changeset and other affected code
  • Manual testing was performed if needed

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

  • A Frontend Frameworks Design member has reviewed these changes
  • There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
  • For release PRs - Version metadata in Rosie comment is correct

@alanknight-wk alanknight-wk changed the title Add an explanatory comment on codemod-generated files INTL-1311:Add an explanatory comment on codemod-generated files May 31, 2023
@aviary2-wf
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

robbecker-wf
robbecker-wf previously approved these changes May 31, 2023
Copy link
Member

@robbecker-wf robbecker-wf left a comment

Choose a reason for hiding this comment

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

This will be helpful

nicbiggs-wk
nicbiggs-wk previously approved these changes May 31, 2023
@robbecker-wf
Copy link
Member

QA+1 CI passes @Workiva/release-management-p

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

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

+1 from RM

@rmconsole4-wk rmconsole4-wk merged commit aee7b2a into master May 31, 2023
@rmconsole4-wk rmconsole4-wk deleted the explanatory_comment_on_intl branch May 31, 2023 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants