diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3dc7c8b26..fe6a66594 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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) diff --git a/.github/workflows/auto-test.yml b/.github/workflows/auto-test.yml index 269e30854..ea7fd79c9 100644 --- a/.github/workflows/auto-test.yml +++ b/.github/workflows/auto-test.yml @@ -21,7 +21,7 @@ jobs: steps: - run: git config --global core.autocrlf false # Mainly for Windows - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e6f7dfad..cf5cb761e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 9042c7e01..38a1bfcb9 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,15 @@ VPS is sponsored by Uptime Kuma sponsors on [Open Collective](https://opencollec * Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server. * Fancy, Reactive, Fast UI/UX. -* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [70+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications). +* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications). * 20 second intervals. * [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/languages) -* Simple Status Page +* Multiple Status Pages +* Map Status Page to Domain * Ping Chart * Certificate Info +* Proxy Support +* 2FA available ## 🔧 How to Install @@ -154,7 +157,7 @@ https://www.reddit.com/r/UptimeKuma/ ## Contribute -### Test Beta Version +### Beta Version Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases