Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (39 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.26 KB
Raw

Contributing

ActDebug is a separate companion to nektos/act. We wrap the act binary; we do not fork act.

Development

cd actdebug
npm install
npm run install-deps   # act binary + Docker check
npm test
npm start              # http://127.0.0.1:3847

With Docker:

sg docker -c 'npm test'
sg docker -c 'npm start'

Project layout

Path Purpose
server.js HTTP API
lib/ act runner, transform, engine, security
public/ Web UI
extensions/vscode/ VS Code / Cursor extension
docs/ Architecture, upstream proposals, community listings
tools/bin/act Bundled nektos/act (pinned version)

See docs/ARCHITECTURE.md.

Upstream act

Optional act CLI hooks we may propose upstream: docs/UPSTREAM_ACT.md.

Community listings

Template for awesome-runners PR: docs/AWESOME_RUNNERS.md.

VS Code extension

cd extensions/vscode
# F5 in VS Code to run Extension Development Host
npx @vscode/vsce package   # optional VSIX

Pull requests

  • Keep changes focused; match existing style.
  • Run npm test before submitting.
  • Do not commit node_modules/ or secrets.