Skip to content

Commit

Permalink
chore(upgrade): format readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tay1orjones committed Jun 28, 2022
1 parent f07c0a5 commit fa9eac5
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions packages/upgrade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,26 @@ Options:
### Migrations
Included within the CLI are a number of migrations available to you to be ran on your project's source files.
Included within the CLI are a number of migrations available to you to be ran on
your project's source files.
Migrations are automated scripts (codemods) ran using the [jscodeshift](https://github.com/facebook/jscodeshift) runner, that will apply intelligent transformations to your code.
Migrations are automated scripts (codemods) ran using the
[jscodeshift](https://github.com/facebook/jscodeshift) runner, that will apply
intelligent transformations to your code.
These migrations range from simple automations like a find and replace of import statements, to more sophisticated migrations that rewrite component prop usage, configuration, and set up. The source of these migrations can be viewed within the [transforms folder](https://github.com/carbon-design-system/carbon/tree/main/packages/upgrade/transforms). Each is tested against a series of test fixtures to ensure transforms are predictable and consistently provide the intended output.
These migrations range from simple automations like a find and replace of import
statements, to more sophisticated migrations that rewrite component prop usage,
configuration, and set up. The source of these migrations can be viewed within
the
[transforms folder](https://github.com/carbon-design-system/carbon/tree/main/packages/upgrade/transforms).
Each is tested against a series of test fixtures to ensure transforms are
predictable and consistently provide the intended output.
## 🙌 Contributing
If you have ideas on how we could make your migration experience easier, please reach out by [opening a new discussion](https://github.com/carbon-design-system/carbon/discussions/new).
If you have ideas on how we could make your migration experience easier, please
reach out by
[opening a new discussion](https://github.com/carbon-design-system/carbon/discussions/new).
We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
Expand Down

0 comments on commit fa9eac5

Please sign in to comment.