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

Align common string modules #9588

Merged

Conversation

nucleogenesis
Copy link
Member

Summary

Applies to the common strings modules the pattern @rtibbles noted here where they will export a getter function as well as the mixin for the case in which one wants to just get a string not in the context of a Vue component.

Some i18n follow-up is needed in general. This pattern could be extended to some of our other string definitions files - but this will make a bit of that easier to do.

Follow-up issue: TBD

I also added documentation re: our common modules - not sure if this is any good or helpful, very much open to feedback on this.

References

Reviewer guidance

Is there room for regression I'm not seeing?

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@nucleogenesis nucleogenesis added TODO: needs review Waiting for review TAG: tech update / debt Change not visible to user TAG: developer docs Technical docs and code comments labels Aug 4, 2022
@nucleogenesis nucleogenesis added this to the 0.16.0 milestone Aug 4, 2022
@rtibbles rtibbles merged commit c1a06b6 into learningequality:develop Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TAG: developer docs Technical docs and code comments TAG: tech update / debt Change not visible to user TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants