Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.71 KB
Raw

Contributing

Kindly create an issue first.

Guidelines

  1. Do not write anything in installation scripts that is not POSIX compatible.
  2. Install with mise. For root, use distros' repos. Use minimum of Homebrew.
  3. If an app is installed, it must work on all Linux distros in README.md.
  4. The app must work on AArch64 Linux as most Apple Macs are ARM64 since 2023.
  5. Do not install if you do not have to lock, use uvx, bunx or mise exec.

Testing

Use alias vv for creating Lima VMs to test on various Linux distros.

For each VM's cloud-init, alias vv sets installer to use the last commit:

curl -fsSL https://raw.githubusercontent.com/raas-dev/configent/main/install.sh | GIT_REF=main sh

If GIT_REF is not set, the installer uses version hardcoded in install.sh.

For testing before commit, alias vv also mounts $HOME/configent read-only.

Pre-commit

Install prek and pre-commit hooks before committing:

prek install --hook-type pre-commit
prek install --hook-type commit-msg

Static code analysis

Run semgrep:

semgrep scan .

See .semgrepignore in repository root. Semgrep also supports inline ignores.

Known issues

  • Lima: Alpine Linux (as of 2025-11)
    • After restarting VM, lima gets stuck in boot waiting ssh to be available
    • Musl binaries for apps may not be available, or may not build from source
      • Install node using apk
- [APP]: [OS AND VERSION] / [ON WHICH ARCH] (as of [LAST CHECKED DATE])
  - [ISSUE]
    - [WORKAROUND]