Skip to content

Latest commit

 

History

History
141 lines (93 loc) · 4.91 KB

CONTRIBUTING.md

File metadata and controls

141 lines (93 loc) · 4.91 KB
Raw

Can I create a pull request for Dockge?

Yes or no, it depends on what you will try to do. Since I don't want to waste your time, be sure to create open a discussion, so we can have a discussion first. Especially for a large pull request or you don't know if it will be merged or not.

Here are some references:

✅ Usually accepted:

  • Bug fix
  • Security fix
  • Adding new language files (see these instructions)
  • Adding new language keys: $t("...")

⚠️ Discussion required:

  • Large pull requests
  • New features

❌ Won't be merged:

  • A dedicated PR for translating existing languages (see these instructions)
  • Do not pass the auto-test
  • Any breaking changes
  • Duplicated pull requests
  • Buggy
  • UI/UX is not close to Dockge
  • Modifications or deletions of existing logic without a valid reason.
  • Adding functions that is completely out of scope
  • Converting existing code into other programming languages
  • Unnecessarily large code changes that are hard to review and cause conflicts with other PRs.

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 will assign your pull request to a milestone, if I plan to review and merge it.

Also, please don't rush or ask for an ETA, because I have to understand the pull request, make sure it is no breaking changes and stick to my vision of this project, especially for large pull requests.

Project Styles

I personally do not like something that requires so many configurations before you can finally start the app.

  • Settings should be configurable in the frontend. Environment variables are discouraged, unless it is related to startup such as DOCKGE_STACKS_DIR
  • Easy to use
  • The web UI styling should be consistent and nice
  • No native build dependency

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

Install Dependencies for Development

pnpm install

Dev Server

pnpm run dev:frontend
pnpm run dev:backend

Backend Dev Server

It binds to 0.0.0.0:5001 by default.

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

Frontend Dev Server

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

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

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

Build the frontend

pnpm run build

Database Migration

TODO

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

Should only be done by the maintainer.

pnpm update

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.