From 3a43fec666783edc5575e5b25fd2ddb404c01ffe Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 25 Oct 2021 12:06:01 +0800 Subject: [PATCH] add recommend pull request guideline --- CONTRIBUTING.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d9b37a3c..c3432c4d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,12 +29,28 @@ The frontend code build into "dist" directory. The server (express.js) exposes t Generally, if the pull request is working fine and it do not affect any existing logic, workflow and perfomance, I will merge into the master branch once it is tested. -If you are not sure, feel free to create an empty pull request draft first. +If you are not sure whether I will accept your pull request, feel free to create an empty pull request draft first. + + +### Recommended Pull Request Guideline + +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. Click "Change to draft" ### Pull Request Examples +Here are some example situations in the past. + #### ✅ High - Medium Priority +Easy to review, no breaking change and not touching the existing code + - Add a new notification - Add a chart - Fix a bug @@ -46,6 +62,13 @@ I do not have such knowledge to test it. - Add k8s supports +#### ⚠ Harsh Mode + +Some pull requests are required to modifiy the core. To be honest, I do not want anyone to try to do that, because it would spend a lot of your time and my time. I will review your pull request harshly. Also you may need to write a lot of unit tests to ensure that there is no breaking change. + +- Touch large parts of code of any very important features of Uptime Kuma +- Drop a table or drop a column for any reason + #### *️⃣ Low Priority It changed my current workflow and require further studies. @@ -54,6 +77,7 @@ It changed my current workflow and require further studies. #### ❌ Won't Merge +- Any breaking changes - Duplicated pull request - Buggy - Existing logic is completely modified or deleted