diff --git a/.github/workflows/stale-bot b/.github/workflows/stale-bot.yml similarity index 100% rename from .github/workflows/stale-bot rename to .github/workflows/stale-bot.yml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d9b37a3c..e521b6c19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,16 +29,33 @@ 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 - Translations +- Add a independent new feature #### *️⃣ Requires one more reviewer @@ -46,6 +63,13 @@ I do not have such knowledge to test it. - Add k8s supports +#### ⚠ Low Priority - 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 +78,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 diff --git a/extra/download-dist.js b/extra/download-dist.js index 0a08b7f90..dc64166c4 100644 --- a/extra/download-dist.js +++ b/extra/download-dist.js @@ -34,9 +34,11 @@ function download(url) { }); tarStream.on("close", () => { - fs.rmdirSync("./dist-backup", { - recursive: true - }); + if (fs.existsSync("./dist-backup")) { + fs.rmdirSync("./dist-backup", { + recursive: true + }); + } console.log("Done"); }); @@ -44,7 +46,7 @@ function download(url) { if (fs.existsSync("./dist-backup")) { fs.renameSync("./dist-backup", "./dist"); } - console.log("Done"); + console.error("Error from tarStream"); }); response.pipe(tarStream);