Prepare fragments of the upgrading guide for pending breaking changes #2521
matthewmayer
started this conversation in
Ideas
Replies: 1 comment 1 reply
-
Any suggestion for a naming strategy for those files? e.g. use PR-number? |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I had an idea, as we approach v9 we will have more and more PRs queued up with breaking changes. Then when we decide that the next release will be v9, these will all need to be merged into
next
. At that point we will have to write the upgrading guide https://fakerjs.dev/guide/upgrading.html for upgrading to v9. We could save time on this by adding markdown fragments to each breaking PR which are later assembled into the full upgrading guide.For example
https://github.com/faker-js/faker/blob/next/docs/guide/upgrading_v9/foo.md in one PR
https://github.com/faker-js/faker/blob/next/docs/guide/upgrading_v9/bar.md in another PR
https://github.com/faker-js/faker/blob/next/docs/guide/upgrading_v9/baz.md in a third PR
This keeps the documentation changes together with the PR itself, allowing them to be easily reviewed.
Then when its time to merge all the PRs, the fragments can simply be concatenated to make the final upgrading.md file.
Beta Was this translation helpful? Give feedback.
All reactions