mirror of
https://github.com/louislam/uptime-kuma.git
synced 2024-11-23 14:54:05 +00:00
Added JSDoc requirement in contributing docs
Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
This commit is contained in:
parent
e56ac7b03b
commit
d3f0bdb440
2 changed files with 2 additions and 0 deletions
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -20,6 +20,7 @@ Please delete any options that are not relevant.
|
|||
- [ ] I ran ESLint and other linters for modified files
|
||||
- [ ] I have performed a self-review of my own code and tested it
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
(including JSDoc for methods)
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] My code needed automated testing. I have added them (this is optional task)
|
||||
|
||||
|
|
|
@ -79,6 +79,7 @@ I personally do not like something need to learn so much and need to config so m
|
|||
- 4 spaces indentation
|
||||
- Follow `.editorconfig`
|
||||
- Follow ESLint
|
||||
- Methods and funtions should be documented with JSDoc
|
||||
|
||||
## Name convention
|
||||
|
||||
|
|
Loading…
Reference in a new issue