Published anonymously with FlowershowReport abuse

Contributing to Acme

We welcome contributions of all kinds โ€” bug fixes, new connectors, documentation improvements, and feature ideas.

Getting started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Install dependencies:
git clone https://github.com/your-username/acme.git
cd acme
make install
  1. Create a feature branch:
git checkout -b feature/my-new-connector

Development setup

[!important] Acme requires Python 3.10+ and Node.js 18+ for development.

# Install development dependencies
pip install -e ".[dev]"

# Run the test suite
make test

# Start the development server
make dev

Project structure

acme/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ connectors/     # Source and destination connectors
โ”‚   โ”œโ”€โ”€ transforms/     # Built-in transform functions
โ”‚   โ”œโ”€โ”€ engine/         # Core pipeline engine
โ”‚   โ”œโ”€โ”€ scheduler/      # Cron and trigger scheduling
โ”‚   โ””โ”€โ”€ api/            # REST API server
โ”œโ”€โ”€ tests/
โ”‚   โ”œโ”€โ”€ unit/
โ”‚   โ”œโ”€โ”€ integration/
โ”‚   โ””โ”€โ”€ fixtures/
โ”œโ”€โ”€ docs/               # Documentation (you are here!)
โ””โ”€โ”€ examples/           # Example pipeline configurations

Submitting a pull request

  1. Ensure all tests pass: make test
  2. Add tests for any new functionality
  3. Update documentation if needed
  4. Submit your PR with a clear description

[!tip] See the Project Structure page for a deeper dive into how the codebase is organized.

Code of conduct

Be respectful, be kind, be constructive. See CODE_OF_CONDUCT.md for details.

Built with LogoFlowershow