CONTRIBUTING.md

Contributing to StableSwapper

Thanks for your interest in contributing! This guide covers how to set up a development environment, run tests, and submit pull requests.

Prerequisites

• Git with signed commits enabled
• See each implementation's README for chain-specific tooling requirements:
  • EVM -- requires Foundry
  • SVM -- requires Rust, Solana CLI, Anchor, and Node.js with Yarn

Getting Started

1. Fork this repository and clone your fork:

git clone https://github.com/<your-username>/stable-swapper.git
cd stable-swapper

2. Initialize submodules:

git submodule update --init --recursive

3. Navigate to the implementation you're working on and follow its README for build and test instructions.

Repository Structure

stable-swapper/
├── evm/          # EVM (Solidity) implementation
├── solana/       # SVM (Rust / Anchor) implementation
├── LICENSE
├── SECURITY.md
├── CONTRIBUTING.md
└── .github/
    ├── workflows/
    └── PULL_REQUEST_TEMPLATE.md

Each implementation directory is self-contained with its own source, tests, and README.

Development Workflow

Branching

1. Create a feature branch from main:

git checkout -b your-feature-name

2. Make your changes and ensure all checks pass (build, tests, formatting).
3. Commit with a signed commit.
4. Push to your fork and open a pull request against main.

Pull Request Guidelines

• Fill out the pull request template completely.
• Keep pull requests focused -- one logical change per PR.
• Include tests for new functionality or bug fixes.
• Ensure all CI checks pass before requesting review.
• All commits must be signed.

Getting Help

• Open a GitHub Issue to report bugs or request features.
• For security vulnerabilities, follow the process in SECURITY.md -- do not file a public issue.