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.

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

docs: deprecation workflow #1067

Merged
merged 20 commits into from
Jun 18, 2022
Merged

docs: deprecation workflow #1067

merged 20 commits into from
Jun 18, 2022

Conversation

xDivisionByZerox
Copy link
Member

@xDivisionByZerox xDivisionByZerox commented Jun 13, 2022

Description

This PR provides documentation on how to deprecate anything in the code base. Also updated all current deprecations according to the documented steps. To make things easier for new contributors I provided a description of the properties of the internal deprecated() function.

Additional information

Related to #976.

@xDivisionByZerox xDivisionByZerox added c: docs Improvements or additions to documentation c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent labels Jun 13, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Jun 13, 2022
@xDivisionByZerox xDivisionByZerox self-assigned this Jun 13, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team June 13, 2022 17:51
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner June 13, 2022 17:51
@codecov
Copy link

codecov bot commented Jun 13, 2022

Codecov Report

Merging #1067 (ec96487) into main (c1cc131) will decrease coverage by 0.00%.
The diff coverage is 91.66%.

@@            Coverage Diff             @@
##             main    #1067      +/-   ##
==========================================
- Coverage   99.64%   99.64%   -0.01%     
==========================================
  Files        2135     2135              
  Lines      229217   229241      +24     
  Branches      979      978       -1     
==========================================
+ Hits       228406   228427      +21     
- Misses        790      793       +3     
  Partials       21       21              
Impacted Files Coverage Δ
src/modules/random/index.ts 98.14% <0.00%> (ø)
src/modules/address/index.ts 98.43% <80.00%> (+<0.01%) ⬆️
src/internal/deprecated.ts 100.00% <100.00%> (ø)
src/modules/commerce/index.ts 100.00% <100.00%> (ø)
src/modules/phone/index.ts 100.00% <100.00%> (ø)
src/modules/finance/index.ts 99.31% <0.00%> (-0.69%) ⬇️

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
src/internal/deprecated.ts Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Jun 14, 2022
ST-DDT
ST-DDT previously approved these changes Jun 14, 2022
Copy link
Member

@import-brain import-brain left a comment

Choose a reason for hiding this comment

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

Sorry for being nitpicky

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
xDivisionByZerox and others added 2 commits June 16, 2022 16:58
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@xDivisionByZerox
Copy link
Member Author

Sorry for being nitpicky

Not at all. I'm aware that my English isn't the best. I would be more stressed if I got no change suggestions.

@Shinigami92
Copy link
Member

ping @xDivisionByZerox

xDivisionByZerox and others added 2 commits June 17, 2022 08:59
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@Shinigami92 Shinigami92 merged commit 6d3f42e into main Jun 18, 2022
@Shinigami92 Shinigami92 deleted the docs/deprecation-workflow branch June 18, 2022 09:16
Minozzzi pushed a commit to Minozzzi/faker that referenced this pull request Jul 19, 2022
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: chore PR that doesn't affect the runtime behavior c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants