Skip to content

Commit

Permalink
docs: Adding the beginning of a migration guide
Browse files Browse the repository at this point in the history
Currently just a list of notes about required/breaking changes in the repo that MFEs will need to address when migrating.
  • Loading branch information
davidjoy committed Jul 3, 2024
1 parent 018b6d3 commit 421dceb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,10 @@ Replace the import from 'frontend-build' with 'frontend-base'.
### 8. Search for any other usages of `frontend-build`

Find any other imports/usages of `frontend-build` in your repository and replace them with `frontend-base` so they don't break.

## Migrating to frontend-base

Currently this section is a quick of notes documenting required changes to MFEs. We will turn this into a more rigorous migration guide in the future.

- First follow the steps above in the "Development" section.
- Description fields are now required on all i18n messages in the repository. This is because of a change to the ESLint config.
2 changes: 1 addition & 1 deletion config/.eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module.exports = {
'formatjs/enforce-description': ['error', 'literal'],
'import/no-import-module-export': 'off',
'react/function-component-definition': [2, { namedComponents: 'arrow-function' }],
"react/jsx-filename-extension": [1, { "extensions": [".tsx", ".jsx"] }]
'react/jsx-filename-extension': [1, { extensions: ['.tsx', '.jsx'] }],
},
globals: {
newrelic: false,
Expand Down

0 comments on commit 421dceb

Please sign in to comment.