From 2547515a376ddb3325f24e74a421dc593a6b4497 Mon Sep 17 00:00:00 2001 From: William Harrison Date: Thu, 16 Nov 2023 20:31:20 +0800 Subject: [PATCH] feat: grammar fixes (#4042) * feat: grammar fixes * Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++---- CONTRIBUTING.md | 35 ++++++++++++++++---------------- README.md | 20 +++++++++--------- SECURITY.md | 8 ++++---- 4 files changed, 34 insertions(+), 36 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6a217143..0dfb5fae 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ Please delete any options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - User interface (UI) - New feature (non-breaking change which adds functionality) -- Breaking change (fix or feature that would cause existing functionality to not work as expected) +- Breaking change (a fix or feature that would cause existing functionality to not work as expected) - Other - This change requires a documentation update @@ -24,9 +24,8 @@ Please delete any options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] 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 +- [ ] I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods) +- [ ] My changes generates no new warnings - [ ] My code needed automated testing. I have added them (this is optional task) ## Screenshots (if any) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f253cff0..33b7336d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ # Project Info -First of all, I want to thank everyone who made pull requests for Uptime Kuma. I never thought the GitHub Community would be so nice! Because of this, I also never thought that other people would actually read and edit my code. It is not very well structured or commented, sorry about that. +First of all, I want to thank everyone who have made pull requests for Uptime Kuma. I never thought the GitHub community would be so nice! Because of this, I also never thought that other people would actually read and edit my code. It is not very well structured or commented, sorry about that. -The project was created with vite.js (vue3). Then I created a subdirectory called "server" for the server part. Both frontend and backend share the same package.json. +The project was created with vite.js (vue3). Then I created a subdirectory called "server" for the server part. Both frontend and backend share the same `package.json`. The frontend code builds into "dist" directory. The server (express.js) exposes the "dist" directory as the root of the endpoint. This is how production is working. ## Key Technical Skills -- Node.js (You should know about promise, async/await and arrow function etc.) +- Node.js (You should know about promises, async/await, arrow functions, etc.) - Socket.io - SCSS - Vue.js @@ -62,7 +62,7 @@ Here are some references: The above cases may not cover all possible situations. -I (@louislam) have the final say. If your pull request does not meet my expectations, I will reject it, no matter how much time you spend on it. Therefore, it is essential to have a discussion beforehand. +I ([@louislam](https://github.com/louislam)) have the final say. If your pull request does not meet my expectations, I will reject it, no matter how much time you spent on it. Therefore, it is essential to have a discussion beforehand. I will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if I plan to review and merge it. @@ -73,15 +73,14 @@ Also, please don't rush or ask for an ETA, because I have to understand the pull Before deep into coding, discussion first is preferred. Creating an empty pull request for discussion would be recommended. 1. Fork the project -1. Clone your fork repo to local -1. Create a new branch -1. Create an empty commit - `git commit -m "[empty commit] pull request for " --allow-empty` -1. Push to your fork repo -1. Create a pull request: https://github.com/louislam/uptime-kuma/compare -1. Write a proper description -1. Click "Change to draft" -1. Discussion +2. Clone your fork repo to local +3. Create a new branch +4. Create an empty commit: `git commit -m "[empty commit] pull request for " --allow-empty` +5. Push to your fork repo +6. Create a pull request: https://github.com/louislam/uptime-kuma/compare +7. Write a proper description +8. Click "Change to draft" +9. Discussion ## Project Styles @@ -114,9 +113,9 @@ I personally do not like something that requires so many configurations before y - IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using [`IntelliJ IDEA`](https://www.jetbrains.com/idea/)) - A SQLite GUI tool (f.ex. [`SQLite Expert Personal`](https://www.sqliteexpert.com/download.html) or [`DBeaver Community`](https://dbeaver.io/download/)) -### GitHub Codespace +### GitHub Codespaces -If you don't want to setup an local environment, you can now develop on GitHub Codespace, read more: +If you don't want to setup an local environment, you can now develop on GitHub Codespaces, read more: https://github.com/louislam/uptime-kuma/tree/master/.devcontainer @@ -231,9 +230,9 @@ If for security / bug / other reasons, a library must be updated, breaking chang ## Translations -Please add **all** the strings which are translatable to `src/lang/en.json` (If translation keys are omitted, they can not be translated). +Please add **all** the strings which are translatable to `src/lang/en.json` (if translation keys are omitted, they can not be translated.) -**Don't include any other languages in your initial Pull-Request** (even if this is your mother tongue), to avoid merge-conflicts between weblate and `master`. +**Don't include any other languages in your initial pull request** (even if this is your mother tongue), to avoid merge-conflicts between weblate and `master`. The translations can then (after merging a PR into `master`) be translated by awesome people donating their language skills. If you want to help by translating Uptime Kuma into your language, please visit the [instructions on how to translate using weblate](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md). @@ -245,7 +244,7 @@ My mother language is not English and my grammar is not that great. ## Wiki -Since there is no way to make a pull request to wiki's repo, I have set up another repo to do that. +Since there is no way to make a pull request to the wiki, I have set up another repo to do that. https://github.com/louislam/uptime-kuma-wiki diff --git a/README.md b/README.md index 8afa9e69..1502f392 100644 --- a/README.md +++ b/README.md @@ -136,26 +136,26 @@ Telegram Notification Sample: ## Motivation -- I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the close ones is statping. Unfortunately, it is not stable and no longer maintained. -- Want to build a fancy UI. +- I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the closest ones is statping. Unfortunately, it is not stable and no longer maintained. +- Wanted to build a fancy UI. - Learn Vue 3 and vite.js. - Show the power of Bootstrap 5. -- Try to use WebSocket with SPA instead of REST API. +- Try to use WebSocket with SPA instead of a REST API. - Deploy my first Docker image to Docker Hub. -If you love this project, please consider giving me a ⭐. +If you love this project, please consider giving it a ⭐. ## 🗣️ Discussion / Ask for Help -⚠️ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask such questions. +⚠️ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask questions there. -I recommend using Google, GitHub Issues, or Uptime Kuma's Subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask: +I recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask: - [GitHub Issues](https://github.com/louislam/uptime-kuma/issues) -- [Subreddit r/Uptime kuma](https://www.reddit.com/r/UptimeKuma/) +- [Subreddit (r/UptimeKuma)](https://www.reddit.com/r/UptimeKuma/) -My Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam). -You can mention me if you ask a question on Reddit. +My Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam) +You can mention me if you ask a question on the subreddit. ## Contribute @@ -181,7 +181,7 @@ If you want to translate Uptime Kuma into your language, please visit [Weblate R ### Spelling & Grammar Feel free to correct the grammar in the documentation or code. -My mother language is not english and my grammar is not that great. +My mother language is not English and my grammar is not that great. ### Create Pull Requests diff --git a/SECURITY.md b/SECURITY.md index db4bc138..72b4fc0f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -3,7 +3,7 @@ ## Reporting a Vulnerability 1. Please report security issues to https://github.com/louislam/uptime-kuma/security/advisories/new. -1. Please also create an empty security issue to alert me, as GitHub Advisories do not send a notification, I probably will miss it without this. https://github.com/louislam/uptime-kuma/issues/new?assignees=&labels=help&template=security.md +2. Please also create an empty security issue to alert me, as GitHub Advisories do not send a notification, I probably will miss it without this. https://github.com/louislam/uptime-kuma/issues/new?assignees=&labels=help&template=security.md Do not use the public issue tracker or discuss it in public as it will cause more damage. @@ -19,12 +19,12 @@ You should use or upgrade to the latest version of Uptime Kuma. All `1.X.X` vers ### Upgradable Docker Tags -| Tag | Supported | -| ------- | ------------------ | +| Tag | Supported | +|-|-| | 1 | :white_check_mark: | | 1-debian | :white_check_mark: | | latest | :white_check_mark: | | debian | :white_check_mark: | | 1-alpine | ⚠️ Deprecated | | alpine | ⚠️ Deprecated | -| All other tags | ❌ | +| All other tags | ❌ |