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: list required JSDoc tags #1397

Merged
merged 4 commits into from
Sep 29, 2022
Merged

docs: list required JSDoc tags #1397

merged 4 commits into from
Sep 29, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Sep 26, 2022

This PR extends the contribution guide with a section which jsdoc tags should be added to new methods.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Sep 26, 2022
@ST-DDT ST-DDT added this to the v7 - Current Major milestone Sep 26, 2022
@ST-DDT ST-DDT self-assigned this Sep 26, 2022
@ST-DDT ST-DDT requested a review from a team September 26, 2022 19:56
@ST-DDT ST-DDT requested a review from a team as a code owner September 26, 2022 19:56
@codecov
Copy link

codecov bot commented Sep 26, 2022

Codecov Report

Merging #1397 (671b44b) into main (2539e6a) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1397   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2163     2163           
  Lines      241306   241306           
  Branches     1017     1017           
=======================================
  Hits       240399   240399           
  Misses        886      886           
  Partials       21       21           

@ST-DDT ST-DDT mentioned this pull request Sep 26, 2022
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@Shinigami92 Shinigami92 changed the title docs: list required jsdocs tags docs: list required JSDoc tags Sep 29, 2022
@Shinigami92 Shinigami92 enabled auto-merge (squash) September 29, 2022 14:37
@Shinigami92 Shinigami92 merged commit e5b608b into main Sep 29, 2022
@Shinigami92 Shinigami92 deleted the docs/required-jsdocs-tags branch September 29, 2022 15:14
wael-fadlallah pushed a commit to wael-fadlallah/faker that referenced this pull request Oct 14, 2022
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

4 participants