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.

Sign up for GitHub

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

Jump to bottom

docs: Document what should appear in migration guide #2138

Merged
merged 13 commits into from
May 12, 2023
Merged

docs: Document what should appear in migration guide #2138

merged 13 commits into from
May 12, 2023

Conversation

matthewmayer
Copy link
Contributor

fix #2079

@matthewmayer matthewmayer requested a review from a team May 8, 2023 02:14
@matthewmayer matthewmayer requested a review from a team as a code owner May 8, 2023 02:14
@matthewmayer matthewmayer self-assigned this May 8, 2023
@matthewmayer matthewmayer added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels May 8, 2023
@codecov
Copy link

codecov bot commented May 8, 2023 •
edited
Loading

Codecov Report

Merging #2138 (a461e07) into next (46b6585) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files 
@@           Coverage Diff           @@
##             next    #2138   +/-   ##
=======================================
  Coverage   99.59%   99.60%           
=======================================
  Files        2607     2607           
  Lines      244977   244977           
  Branches     1146     1153    +7     
=======================================
+ Hits       243992   244006   +14     
+ Misses        958      944   -14     
  Partials       27       27

see 1 file with indirect coverage changes

@ST-DDT ST-DDT added the s: needs decision Needs team/maintainer decision label May 8, 2023
ST-DDT
ST-DDT reviewed May 9, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
matthewmayer and others added 2 commits May 10, 2023 07:27
Shinigami92
Shinigami92 reviewed May 10, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
ST-DDT
ST-DDT previously approved these changes May 10, 2023
View reviewed changes
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text wise this looks good to me.
Not sure whether we need it.

@matthewmayer
Copy link
Contributor Author

i feel its useful to have it somewhere to refer people to if we ask them to document (or not document) changes in the guide.

import-brain
import-brain reviewed May 12, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@matthewmayer @import-brain
Update CONTRIBUTING.md
1825b67 
Co-authored-by: Eric Cheng <[email protected]>
matthewmayer and others added 5 commits May 12, 2023 07:35
@matthewmayer @import-brain
Update CONTRIBUTING.md
10bc9bd 
Co-authored-by: Eric Cheng <[email protected]>
@matthewmayer @import-brain
Update CONTRIBUTING.md
ccf4f92 
Co-authored-by: Eric Cheng <[email protected]>
@matthewmayer @import-brain
Update CONTRIBUTING.md
4defcc5 
Co-authored-by: Eric Cheng <[email protected]>
@matthewmayer @import-brain
Update CONTRIBUTING.md
9849046 
Co-authored-by: Eric Cheng <[email protected]>
@matthewmayer @import-brain
Update CONTRIBUTING.md
89f21c7 
Co-authored-by: Eric Cheng <[email protected]>
ST-DDT
ST-DDT previously approved these changes May 12, 2023
View reviewed changes
@ST-DDT ST-DDT requested review from a team, import-brain and Shinigami92 May 12, 2023 06:24
Shinigami92
Shinigami92 reviewed May 12, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@matthewmayer @Shinigami92
Update CONTRIBUTING.md
303a9f8 
Co-authored-by: Shinigami <[email protected]>
Shinigami92
Shinigami92 previously approved these changes May 12, 2023
View reviewed changes
ST-DDT
ST-DDT reviewed May 12, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@ST-DDT ST-DDT requested review from Shinigami92 and a team May 12, 2023 08:40
xDivisionByZerox
xDivisionByZerox approved these changes May 12, 2023
View reviewed changes
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH, I think this section is currently a little too verbose. Most one-time contributors will not implement anything that is noteworthy in the migrations guide. And if they do so the faker team can guide them in the review process.

On the other side, I'm happy that it is written somewhere, at least.

@matthewmayer
Copy link
Contributor Author

I think in general CONTRIBUTING is probably too verbose but probably easiest to add this and do a general cleanup/shortening later.

@Shinigami92 Shinigami92 merged commit e0e9ae8 into faker-js:next May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

@import-brain import-brain import-brain approved these changes

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@ST-DDT ST-DDT ST-DDT approved these changes

Assignees

@matthewmayer matthewmayer

Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.x
Development

Successfully merging this pull request may close these issues.

Document what should appear in migration guide
5 participants
@matthewmayer @ST-DDT @Shinigami92 @import-brain @xDivisionByZerox