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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xDivisionByZerox
added
c: docs
Improvements or additions to documentation
p: 1-normal
Nothing urgent
labels
Jun 23, 2022
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. |
Codecov Report
@@ 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
|
I get it now... |
Shinigami92
reviewed
Jun 24, 2022
import-brain
requested changes
Jun 25, 2022
ST-DDT
reviewed
Jun 25, 2022
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Shinigami92
reviewed
Jun 26, 2022
Co-authored-by: Shinigami <chrissi92@hotmail.de> docs(contributing): reword JSDocs empty line example Co-authored-by: Shinigami <chrissi92@hotmail.de>
xDivisionByZerox
force-pushed
the
docs/contributing/code-standards
branch
from
June 26, 2022 10:33
6f6eacf
to
ce89a51
Compare
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
force-pushed
the
docs/contributing/code-standards
branch
from
June 26, 2022 10:53
baf32c5
to
83dd57f
Compare
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
import-brain
approved these changes
Jun 26, 2022
ST-DDT
approved these changes
Jun 28, 2022
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents coding standards we expect from contributors, that are currently only documented in an intern shared file.