Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (42 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.6 KB

Contributing

Branching

  • Always branch from main using a conventional prefix:
    • feat/ — new feature
    • fix/ — bug fix
    • docs/ — documentation only
    • chore/ — maintenance, dependency updates, config changes
    • refactor/ — code restructure with no behaviour change
    • test/ — adding or updating tests

Making Changes

  • Keep commits small and atomic with conventional commit messages: 
    feat: add support for custom Chromium flags
fix: prevent container crash when SHM_SIZE is unset
docs: add reverse proxy setup example
  • Update documentation alongside any functional change — README.md, .env.example, and any affected config comments.

Pull Requests

  • One feature or fix per PR. Split large changes into stacked PRs.
  • Rebase on main before opening (git fetch origin && git rebase origin/main).
  • PR title must follow conventional commit format.
  • PR description must include:
    • What: what changed
    • Why: motivation
    • How: approach (if non-obvious)
    • Testing: how it was tested
  • Do not merge your own PR.

Testing Locally

# Start the container
docker compose up -d

# Tail logs
docker compose logs -f chromium

# Verify both ports respond
curl -su admin:yourpassword http://localhost:3000 -o /dev/null -w "%{http_code}\n"
curl -sku admin:yourpassword https://localhost:3001 -o /dev/null -w "%{http_code}\n"

# Test clean-start mode
CLEAN_START=true docker compose up -d
docker compose logs chromium | grep clean

License

By contributing you agree that your changes will be licensed under the MIT License.