Skip to content

Latest commit

 

History

History
255 lines (168 loc) · 6.76 KB

CONTRIBUTING.md

File metadata and controls

255 lines (168 loc) · 6.76 KB
Raw

Project Info

First of all, thank you everyone who made pull requests for Uptime Kuma, I never thought GitHub Community can be that nice! And also because of this, I also never thought other people actually read my code and edit my code. It is not structed and commented so well, lol. Sorry about that.

The project was created with vite.js (vue3). Then I created a sub-directory called "server" for server part. Both frontend and backend share the same package.json.

The frontend code build into "dist" directory. The server (express.js) exposes the "dist" directory as root of the endpoint. This is how production is working.

Key Technical Skills

  • Node.js (You should know what are promise, async/await and arrow function etc.)
  • Socket.io
  • SCSS
  • Vue.js
  • Bootstrap
  • SQLite

Directories

  • data (App data)
  • dist (Frontend build)
  • extra (Extra useful scripts)
  • public (Frontend resources for dev only)
  • server (Server source code)
  • src (Frontend source code)
  • test (unit test)

Can I create a pull request for Uptime Kuma?

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 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
  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 <YOUR TASK NAME>" --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"

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

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. 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
  • Touch monitoring logic
  • Drop a table or drop a column for any reason
  • Touch the entry point of Docker or Node.js
  • Modifiy auth

*️⃣ Low Priority

It changed my current workflow and require further studies.

  • Change my release approach

❌ Won't Merge

  • Any breaking changes
  • Duplicated pull request
  • Buggy
  • Existing logic is completely modified or deleted
  • A function that is completely out of scope

Project Styles

I personally do not like something need to learn so much and need to config so much before you can finally start the app.

  • Easy to install for non-Docker users, no native build dependency is needed (at least for x86_64), no extra config, no extra effort to get it run
  • Single container for Docker users, no very complex docker-compose file. Just map the volume and expose the port, then good to go
  • Settings should be configurable in the frontend. Env var is not encouraged.
  • Easy to use

Coding Styles

  • 4 spaces indentation
  • Follow .editorconfig
  • Follow ESLint

Name convention

  • Javascript/Typescript: camelCaseType
  • SQLite: underscore_type
  • CSS/SCSS: dash-type

Tools

  • Node.js >= 14
  • Git
  • IDE that supports ESLint and EditorConfig (I am using Intellji Idea)
  • A SQLite tool (SQLite Expert Personal is suggested)

Install dependencies

npm ci

How to start the Backend Dev Server

(2021-09-23 Update)

npm run start-server-dev

It binds to 0.0.0.0:3001 by default.

Backend Details

It is mainly a socket.io app + express.js.

express.js is just used for serving the frontend built files (index.html, .js and .css etc.)

  • model/ (Object model, auto mapping to the database table name)
  • modules/ (Modified 3rd-party modules)
  • notification-providers/ (indivdual notification logic)
  • routers/ (Express Routers)
  • scoket-handler (Socket.io Handlers)
  • server.js (Server main logic)

How to start the Frontend Dev Server

  1. Set the env var NODE_ENV to "development".

  2. Start the frontend dev server by the following command.

    npm run dev

    It binds to 0.0.0.0:3000 by default.

You can use Vue.js devtools Chrome extension for debugging.

Build the frontend

npm run build

Frontend Details

Uptime Kuma Frontend is a single page application (SPA). Most paths are handled by Vue Router.

The router is in src/router.js

As you can see, most data in frontend is stored in root level, even though you changed the current router to any other pages.

The data and socket logic are in src/mixins/socket.js.

Database Migration

  1. Create patch-{name}.sql in ./db/
  2. Add your patch filename in the patchList list in ./server/database.js

Unit Test

It is an end-to-end testing. It is using Jest and Puppeteer.

npm run build
npm test

By default, the Chromium window will be shown up during the test. Specifying HEADLESS_TEST=1 for terminal environments.

Update Dependencies

Install ncu https://github.com/raineorshine/npm-check-updates

ncu -u -t patch
npm install

Since previously updating vite 2.5.10 to 2.6.0 broke the application completely, from now on, it should update patch release version only.

Patch release = the third digit (Semantic Versioning)

Translations

Please read: https://github.com/louislam/uptime-kuma/tree/master/src/languages

Wiki

Since there is no way to make a pull request to wiki's repo, I have setup another repo to do that.

https://github.com/louislam/uptime-kuma-wiki

Maintainer

Check the latest issues and pull requests: https://github.com/louislam/uptime-kuma/issues?q=sort%3Aupdated-desc

Release Procedures

  1. Draft a release note
  2. Make sure the repo is cleared
  3. npm run update-version 1.X.X
  4. npm run build
  5. npm run build-docker
  6. git push
  7. Publish the release note as 1.X.X
  8. npm run upload-artifacts
  9. SSH to demo site server and update to 1.X.X

Checking:

Release Wiki

Setup Repo

git clone https://github.com/louislam/uptime-kuma-wiki.git
cd uptime-kuma-wiki
git remote add production https://github.com/louislam/uptime-kuma.wiki.git

Push to Production Wiki

git pull
git push production master