Skip to content

Latest commit

 

History

History
518 lines (393 loc) · 20.8 KB

CONTRIBUTING.md

File metadata and controls

518 lines (393 loc) · 20.8 KB
Raw

Project Info

First of all, I want to thank everyone who have wrote issues or shared 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. Parts of the code are not very well-structured or commented, sorry about that.

The project was created with vite.js and is written in vue3. Our backend lives in the server-directory and mostly communicates via websockets. Both frontend and backend share the same package.json.

For production, the frontend is build into dist-directory and the server (express.js) exposes the dist directory as the root of the endpoint. For development, we run vite in development mode on another port.

Directories

  • config (dev config files)
  • data (App data)
  • db (Base database and migration scripts)
  • dist (Frontend build)
  • docker (Dockerfiles)
  • 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?

Yes or no, it depends on what you will try to do. Both your and our maintainers time is precious, and we don't want to waste both time.

If you have any questions about any process/.. is not clear, you are likely not alone => please ask them ^^

Different guidelines exist for different types of pull requests (PRs):

  • security fixes

    Submitting security fixes is something that may put the community at risk. Please read through our security policy and submit vulnerabilities via an advisory + issue instead. We encourage you to submit how to fix a vulnerability if you know how to, this is not required. Following the security policy allows us to properly test, fix bugs. This review allows us to notice, if there are any changes necessary to unrelated parts like the documentation.
    PLEASE SEE OUR SECURITY POLICY.

  • small, non-breaking bug fixes

    If you come across a bug and think you can solve, we appreciate your work. Please make sure that you follow by these rules:

    • keep the PR as small as possible, fix only one thing at a time => keeping it reviewable
    • test that your code does what you came it does.

    Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.

  • translations / internationalisation (i18n)

    We use weblate to localise this project into many languages. If you are unhappy with a translation this is the best start. On how to translate using weblate, please see these instructions.

    There are two cases in which a change cannot be done in weblate and requires a PR:

    • A text may not be currently localisable. In this case, adding a new language key via $t("languageKey") might be nessesary
    • language keys need to be added to en.json to be visible in weblate. If this has not happened, a PR is appreciated.
    • Adding a new language requires a new file see these instructions

    Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.

  • new notification providers

    To set up a new notification provider these files need to be modified/created:

    • server/notification-providers/PROVIDER_NAME.js is where the heart of the notification provider lives.
      • Both monitorJSON and heartbeatJSON can be null for some events. If both are null, this is a general testing message, but if just heartbeatJSON is null this is a certificate expiry.
      • Please wrap the axios call into a 
        try {
  let result = await axios.post(...);
  if (result.status === ...) ...
} catch (error) {
  this.throwGeneralAxiosError(error);
}
    • server/notification.js is where the backend of the notification provider needs to be registered. If you have an idea how we can skip this step, we would love to hear about it ^^
    • src/components/NotificationDialog.vue you need to decide if the provider is a regional or a global one and add it with a name to the respective list
    • src/components/notifications/PROVIDER_NAME.vue is where the frontend of each provider lives. Please make sure that you have:
      • used HiddenInput for secret credentials
      • included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users.
      • include all translations ({{ $t("Translation key") }}, i18n-t keypath="Translation key">) in src/lang/en.json to enable our translators to translate this
    • src/components/notifications/index.js is where the frontend of the provider needs to be registered. If you have an idea how we can skip this step, we would love to hear about it ^^

    Offering notifications is close to the core of what we are as an uptime monitor. Therefore, making sure that they work is also really important. Because testing notification providers is quite time intensive, we mostly offload this onto the person contributing a notification provider.

    To make shure you have tested the notification provider, please include screenshots of the following events in the pull-request description:

    Using the following way to format this is encouraged:

    | Event | Before | After |
------------------
| `UP` | paste-image-here | paste-image-here |
| `DOWN` | paste-image-here | paste-image-here |
| Certificate-expiry | paste-image-here | paste-image-here |
| Testing | paste-image-here | paste-image-here |

    Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.

  • new monitoring types

    To set up a new notification provider these files need to be modified/created:

    • server/monitor-types/MONITORING_TYPE.js is the core of each monitor. the async check(...)-function should:
      • throw an error for each fault that is detected with an actionable error message
      • in the happy-path, you should set heartbeat.msg to a successful message and set heartbeat.status = UP
    • server/uptime-kuma-server.js is where the monitoring backend needs to be registered. If you have an idea how we can skip this step, we would love to hear about it ^^
    • src/pages/EditMonitor.vue is the shared frontend users interact with. Please make sure that you have:
      • used HiddenInput for secret credentials
      • included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users.
      • include all translations ({{ $t("Translation key") }}, i18n-t keypath="Translation key">) in src/lang/en.json to enable our translators to translate this

    Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.

  • new features/ major changes / breaking bugfixes

    be sure to create an empty draft pull request or open an issue, so we can have a discussion first. This is especially important for a large pull request or you don't know if it will be merged or not.

    Because of the large impact of this work, only senior maintainers may merge PRs in this area.

The following rules are essential for making your PR mergable:

  • Merging multiple issues by a huge PR is more difficult to review and causes conflicts with other PRs. Please
    • (if possible) create one PR for one issue or
    • (if not possible) explain which issues a PR addresses and why this PR should not be broken apart
  • Make sure your PR passes our continuous integration. PRs will not be merged unless all CI-Checks are green.
  • Breaking changes (unless for a good reason and discussed beforehand) will not get merged / not get merged quickly. Such changes require a major version release.
  • Test your code before submitting a PR. Buggy PRs will not be merged.
  • Make sure the UI/UX is close to Uptime Kuma.
  • Think about the maintainability: Don't add functionality that is completely out of scope. Keep in mind that we need to be able to maintain the functionality.
  • Don't modify or delete existing logic without a valid reason.
  • Don't convert existing code into other programming languages for no reason.

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 spent on it. Therefore, it is essential to have a discussion beforehand.

I will assign your pull request to a milestone, if I plan to review and merge it.

Please don't rush or ask for an ETA. We have to understand the pull request, make sure it has no breaking changes and stick to the vision of this project, especially for large pull requests.

I'd like to work on an issue. How do I do that?

We have found that assigning people to issues is management-overhead that we don't need. A short comment that you want to try your hand at this issue is appreciated to save other devs time. If you come across any problem during development, feel free to leave a comment with what you are stuck on.

Recommended Pull Request Guideline

Before diving deep into coding, having a discussion first by creating an empty pull request for discussion is preferred. The rationale behind this is that we can align the direction and scope of the feature to eliminate any conflicts with existing and planned work, and can help by pointing out any potential pitfalls.

  1. Fork the project
  2. Clone your fork repo to local
  3. Create a new branch
  4. Create an empty commit: git commit -m "<YOUR TASK NAME>" --allow-empty
  5. Push to your fork repo
  6. Prepare a pull request: https://github.com/louislam/uptime-kuma/compare
  7. Write a proper description. You can mention @louislam in it, so @louislam will get the notification.
  8. Create your pull request as a Draft
  9. Wait for the discussion

Project Styles

I personally do not like something that requires so many configurations before you can finally start the app. The goal is to make the Uptime Kuma installation as easy as installing a mobile app.

  • Easy to install for non-Docker users
    • no native build dependency is needed (for x86_64/armv7/arm64)
    • no extra configuration and
    • no extra effort required to get it running
  • Single container for Docker users
    • no complex docker-compose file
    • mapping the volume and exposing the port should be the only requirements
  • Settings should be configurable in the frontend. Environment variables are discouraged, unless it is related to startup such as DATA_DIR
  • Easy to use
  • The web UI styling should be consistent and nice

Coding Styles

  • 4 spaces indentation
  • Follow .editorconfig
  • Follow ESLint
  • Methods and functions should be documented with JSDoc

Name Conventions

  • Javascript/Typescript: camelCaseType
  • SQLite: snake_case (Underscore)
  • CSS/SCSS: kebab-case (Dash)

Tools

GitHub Codespaces

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

Git Branches

  • master: 2.X.X development. If you want to add a new feature, your pull request should base on this.
  • 1.23.X: 1.23.X development. If you want to fix a bug for v1 and v2, your pull request should base on this.
  • All other branches are unused, outdated or for dev.

Install Dependencies for Development

npm ci

Dev Server

(2022-04-26 Update)

We can start the frontend dev server and the backend dev server in one command.

Port 3000 and port 3001 will be used.

npm run dev

But sometimes, you would like to restart the server, but not the frontend, you can run these commands in two terminals:

npm run start-frontend-dev
npm run start-server-dev

Backend Server

It binds to 0.0.0.0:3001 by default.

The backend is an express.js server with socket.io integrated. It uses socket.io to communicate with clients, and most server logic is encapsulated in the socket.io handlers. express.js is also used to serve:

  • as an entry point for redirecting to a status page or the dashboard
  • the frontend built files (index.html, *.js, *.css, etc.)
  • internal APIs of the status page

Structure in /server/

  • jobs/ (Jobs that are running in another process)
  • model/ (Object model, auto-mapping to the database table name)
  • modules/ (Modified 3rd-party modules)
  • monitor_types/ (Monitor Types)
  • notification-providers/ (individual notification logic)
  • routers/ (Express Routers)
  • socket-handler/ (Socket.io Handlers)
  • server.js (Server entry point)
  • uptime-kuma-server.js (UptimeKumaServer class, main logic should be here, but some still in server.js)

Frontend Dev Server

It binds to 0.0.0.0:3000 by default. The frontend dev server is used for development only.

For production, it is not used. It will be compiled to dist directory instead.

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 the frontend is stored at the 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

See: https://github.com/louislam/uptime-kuma/tree/master/db/knex_migrations

Unit Test

npm run build
npm test

Dependencies

Both frontend and backend share the same package.json. However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into dist files. So:

  • Frontend dependencies = "devDependencies"
    • Examples: vue, chart.js
  • Backend dependencies = "dependencies"
    • Examples: socket.io, sqlite3
  • Development dependencies = "devDependencies"
    • Examples: eslint, sass

Update Dependencies

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

Patch release = the third digit (Semantic Versioning)

If for security / bug / other reasons, a library must be updated, breaking changes need to be checked by the person proposing the change.

Translations

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. 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.

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.

Wiki

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

Docker

Arch

  • amd64
  • arm64
  • armv7

Docker Tags

v2

  • 2, latest-2: v2 with full features such as Chromium and bundled MariaDB
  • 2.x.x
  • 2-slim: v2 with basic features
  • 2.x.x-slim
  • beta2: Latest beta build
  • 2.x.x-beta.x
  • nightly2: Dev build
  • base2: Basic Debian setup without Uptime Kuma source code (Full features)
  • base2-slim: Basic Debian setup without Uptime Kuma source code
  • pr-test2: For testing pull request without setting up a local environment

v1

  • 1, latest, 1-debian, debian: Latest version of v1
  • 1.x.x, 1.x.x-debian
  • 1.x.x-beta.x: Beta build
  • beta: Latest beta build
  • nightly: Dev build
  • base-debian: Basic Debian setup without Uptime Kuma source code
  • pr-test: For testing pull request without setting up a local environment
  • base-alpine: (Deprecated) Basic Alpine setup without Uptime Kuma source code
  • 1-alpine, alpine: (Deprecated)
  • 1.x.x-alpine: (Deprecated)

Maintainer

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

What is a maintainer and what are their roles?

This project has multiple maintainers which specialise in different areas. Currently, there are 3 maintainers:

Person Role Main Area
@louislam senior maintainer major features
@chakflying junior maintainer fixing bugs
@commanderstorm junior maintainer issue-management

Procedures

We have a few procedures we follow. These are documented here:

  • Set up a Docker Builder

    • amd64, armv7 using local.
    • arm64 using remote arm64 cpu, as the emulator is too slow and can no longer pass the npm ci command.
      1. Add the public key to the remote server.
      2. Add the remote context. The remote machine must be arm64 and installed Docker CE. 
        docker context create oracle-arm64-jp --docker "host=ssh://[email protected]"
      3. Create a new builder. 
        docker buildx create --name kuma-builder --platform linux/amd64,linux/arm/v7
docker buildx use kuma-builder
docker buildx inspect --bootstrap
      4. Append the remote context to the builder. 
        docker buildx create --append --name kuma-builder --platform linux/arm64 oracle-arm64-jp
      5. Verify the builder and check if the builder is using kuma-builder. 
        docker buildx inspect kuma-builder
docker buildx ls

  • Release

    1. Draft a release note
    2. Make sure the repo is cleared
    3. If the healthcheck is updated, remember to re-compile it: npm run build-docker-builder-go
    4. npm run release-final with env vars: VERSION and GITHUB_TOKEN
    5. Wait until the Press any key to continue
    6. git push
    7. Publish the release note as 1.X.X
    8. Press any key to continue
    9. Deploy to the demo server: npm run deploy-demo-server

    These Items need to be checked:

  • Release Beta

    1. Draft a release note, check This is a pre-release
    2. Make sure the repo is cleared
    3. npm run release-beta with env vars: VERSION and GITHUB_TOKEN
    4. Wait until the Press any key to continue
    5. Publish the release note as 1.X.X-beta.X
    6. Press any key to continue

  • 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

  • Change the base of a pull request such as master to 1.23.X 

    git rebase --onto <new parent> <old parent>