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

Add "Author should include JSDoc" to PR template #2718

Closed
yusukebe opened this issue May 18, 2024 · 2 comments · Fixed by #2840
Closed

Add "Author should include JSDoc" to PR template #2718

yusukebe opened this issue May 18, 2024 · 2 comments · Fixed by #2840
Labels
enhancement New feature or request.

Comments

@yusukebe
Copy link
Member

What is the feature you are proposing?

Context: #2615 (comment)

I'm thinking we should improve the PR template to tell every PR that adding a new feature should add TSDoc/JSDoc (if it's necessary) @yusukebe This way we can slowly migrate codebase to use TSDoc/JSDoc

@yusukebe yusukebe added the enhancement New feature or request. label May 18, 2024
@EdamAme-x
Copy link
Contributor

EdamAme-x commented May 28, 2024

If this is to be implemented, we also need to add a guide on how to write it (jsdoc).

e.x.
JSDoc must includes description, @ see, @ param, @ returns, if needs @ throws, @ example

@fzn0x
Copy link
Contributor

fzn0x commented May 28, 2024

If this is to be implemented, we also need to add a guide on how to write it (jsdoc).

e.x. JSDoc must includes description, @ see, @ param, @ returns, if needs @ throws, @ example

I have something simpler in mind will create a PR soon :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants