Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.56 KB

Contributing to TPS

We welcome contributions to the Team Provisioning System! TPS is built to be a robust, secure kernel for Agent OS development.

Development Setup

TPS is built with TypeScript and Bun.

# Clone the repository
git clone https://github.com/tpsdev-ai/tps.git
cd tps

# Install dependencies
bun install

# Build the CLI
bun run build

# Run tests
bun test

Architecture Notes

Before contributing, please read the ARCHITECTURE.md. TPS uses a strict hub-and-spoke topology and isolates communication across three channels (Mail, Git, APIs).

When modifying the branch daemon or transport layers, keep the following security boundaries in mind:

  • Never expose the Host's private key.
  • Always validate inputs on cross-boundary messaging.
  • Fail closed on authentication or permission errors.

Code Quality

  • We use Biome for linting. Run bun run lint before committing.
  • Ensure all tests pass (bun test). We aim for high test coverage, especially in src/utils/identity.ts, src/utils/relay.ts, and the transport layers.
  • Write tests for new features.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/my-new-feature).
  3. Make your changes and commit (git commit -am 'feat: add some feature').
  4. Push to the branch (git push origin feature/my-new-feature).
  5. Open a Pull Request.

Please describe the problem your PR solves and the approach you took. For significant architectural changes, consider opening an issue first for discussion.