Missing String Instructions

[ehuthmacher]

Some strings do not have string instructions, making it harder for translators to grasp the context. Please ensure that all strings include relevant instructions.

[ehuthmacher]

@ghassanmas please add example

[ehuthmacher]

automating this process would be ideal.

[ghassanmas]

Here is an example from openedx/frontend-app-learning/pull/1143 which its action failed beacuse it found ~+70 message with no description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/alerts/sequence-alerts/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/goal-unsubscribe/ResultPage.jsx
Error:   11:5  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/outline-tab/alerts/certificate-status-alert/CertificateStatusAlert.jsx
Error:   67:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/outline-tab/alerts/certificate-status-alert/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/outline-tab/alerts/scheduled-content-alert/ScheduledCotentAlert.jsx
Error:   16:13  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   21:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   31:15  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/outline-tab/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/progress-tab/credit-information/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/course-home/progress-tab/grades/grade-summary/DroppableAssignmentFootnote.jsx
Error:   24:13  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/courseware/course/content-tools/calculator/Calculator.jsx
Error:    91:17  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   147:19  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   291:23  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   297:23  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/courseware/course/course-exit/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/courseware/course/sequence/hidden-after-due/HiddenAfterDue.jsx
Error:   33:13  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/courseware/social-share/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/generic/upgrade-button/UpgradeButton.jsx
Error:   29:9  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/generic/upgrade-button/UpgradeNowButton.jsx
Error:   28:7  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/generic/upgrade-button/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/generic/upgrade-notification/UpgradeNotification.jsx
Error:    35:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:    54:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:    64:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:    74:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:    98:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   123:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   146:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   169:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   198:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   240:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   363:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   381:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   399:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   420:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   439:7   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   472:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/AbandonTour.jsx
Error:   8:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/CoursewareTour.jsx
Error:   8:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/ExistingUserCourseHomeTour.jsx
Error:   8:11  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/newUserCourseHomeTour/NewUserCourseHomeTour.jsx
Error:   10:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   16:10  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   23:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   29:10  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   36:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   42:10  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   49:9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   55:10  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   [62](https://github.com/openedx/frontend-app-learning/actions/runs/5601655361/jobs/10245838697?pr=1143#step:5:63):9   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   68:10  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/product-tours/newUserCourseHomeTour/NewUserCourseHomeTourModal.jsx
Error:   31:13  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/shared/effort-estimate/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/shared/streak-celebration/StreakCelebrationModal.jsx
Error:    27:6   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:    35:6   error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   189:17  error  `description` has to be specified in message descriptor  formatjs/enforce-description

/home/runner/work/frontend-app-learning/frontend-app-learning/src/shared/streak-celebration/messages.js
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description
Error:   3:18  error  `description` has to be specified in message descriptor  formatjs/enforce-description

✖ [72](https://github.com/openedx/frontend-app-learning/actions/runs/5601655361/jobs/10245838697?pr=1143#step:5:73) problems (72 errors, 0 warnings)

make[1]: *** [Makefile:73: validate] Error 1
make: *** [Makefile:80: validate.ci] Error 2
make[1]: Leaving directory '/home/runner/work/frontend-app-learning/frontend-app-learning'
Error: Process completed with exit code 2.

[ehuthmacher]

@brian-smith-tcril Any updates on this?

[brian-smith-tcril]

@ehuthmacher I believe this is related to this PR, I left a comment recommending we add a check org-wide.

[ehuthmacher]

@brian-smith-tcril Who is the maintainer/reviewer for the following PR: https://github.com/openedx/frontend-build/pull/460 ? We need confirmation that this change will be accepted. I reopened the issue