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(contributing): jsdocs section #1104

Merged
merged 14 commits into from Jun 30, 2022
Merged

Conversation

xDivisionByZerox
Copy link
Member

This PR documents coding standards we expect from contributors, that are currently only documented in an intern shared file.

@xDivisionByZerox xDivisionByZerox added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Jun 23, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Jun 23, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team June 23, 2022 21:40
@xDivisionByZerox xDivisionByZerox self-assigned this Jun 23, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team June 23, 2022 21:40
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner June 23, 2022 21:40
@xDivisionByZerox
Copy link
Member Author

I first wanted to include all our intern documentation in this PR, but I think it's much easier to discuss if we add each section/topic in an extra PR. I also think this will make backtracking in the git history simpler.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jun 23, 2022

Codecov Report

Merging #1104 (d8fcc43) into main (eb0bbee) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1104   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files        2146     2146           
  Lines      230393   230393           
  Branches      978      979    +1     
=======================================
+ Hits       229580   229582    +2     
+ Misses        792      790    -2     
  Partials       21       21           
Impacted Files Coverage Δ
src/modules/name/index.ts 98.91% <0.00%> (-1.09%) ⬇️
src/modules/internet/user-agent.ts 86.95% <0.00%> (+0.57%) ⬆️
src/modules/finance/index.ts 100.00% <0.00%> (+0.68%) ⬆️

CONTRIBUTING.md Outdated Show resolved Hide resolved
@xDivisionByZerox
Copy link
Member Author

xDivisionByZerox commented Jun 23, 2022

Why does markdown have to be formatted by prettier?^^

I get it now...

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
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 Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
xDivisionByZerox and others added 2 commits June 26, 2022 12:25
Co-authored-by: Shinigami <chrissi92@hotmail.de>

docs(contributing): reword JSDocs empty line example

Co-authored-by: Shinigami <chrissi92@hotmail.de>
@xDivisionByZerox xDivisionByZerox force-pushed the docs/contributing/code-standards branch from 6f6eacf to ce89a51 Compare June 26, 2022 10:33
xDivisionByZerox and others added 5 commits June 26, 2022 12:35
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@xDivisionByZerox xDivisionByZerox force-pushed the docs/contributing/code-standards branch from baf32c5 to 83dd57f Compare June 26, 2022 10:53
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@Shinigami92 Shinigami92 merged commit 1cb9312 into main Jun 30, 2022
@Shinigami92 Shinigami92 deleted the docs/contributing/code-standards branch June 30, 2022 10:36
Minozzzi pushed a commit to Minozzzi/faker that referenced this pull request Jul 19, 2022
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
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: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants