Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (60 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

87 lines (60 loc) · 1.65 KB

Contributing to agent-slack

Thanks for contributing.

Attribution

If you'd like to be credited when we share your contribution on X, include your Twitter/X handle in your PR description.

Development

Install deps and run the CLI in dev mode:

bun install
bun run dev -- --help

Build and test:

bun run build
bun run test
bun run typecheck

Lint and format:

bun run lint
bun run format:check

Run via Bun directly (for local development):

bun ./bin/agent-slack.bun.js --help

Releasing (maintainers)

Releases are binary-only via GitHub Releases. No npm publishing.

Using the release script

# Bump to explicit version
bun run release 0.2.0

# Or use semver bump type
bun run release patch   # 0.1.0 -> 0.1.1
bun run release minor   # 0.1.0 -> 0.2.0
bun run release major   # 0.1.0 -> 1.0.0

The script will:

  1. Update version in package.json
  2. Commit with message v{version}
  3. Create git tag v{version}
  4. Push to origin (after confirmation)

Pushing the tag triggers the GitHub Actions Release workflow, which:

  • Builds native binaries for all platforms (macOS, Linux, Windows × x64, arm64)
  • Generates checksums
  • Uploads everything to the GitHub Release

Manual release (alternative)

# 1. Update version in package.json
# 2. Commit and tag
git add package.json
git commit -m "v0.2.0"
git tag v0.2.0
git push origin main --tags

User installation

Users install the binary via:

curl -fsSL https://raw.githubusercontent.com/stablyai/agent-slack/main/install.sh | sh

Or download directly from GitHub Releases.