Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (47 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.07 KB
Raw

Contributing to Stablecoin

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

Prerequisites

Getting Started

  1. Fork this repository and clone your fork:
git clone https://github.com/<your-username>/custom-stablecoin.git
cd custom-stablecoin
  1. Initialize submodules:
git submodule update --init --recursive
  1. Navigate to the implementation you're working on and follow its README for build and test instructions.

Repository Structure

custom-stablecoin/
├── evm/          # EVM (Solidity) implementation
├── LICENSE
├── SECURITY.md
├── CONTRIBUTING.md
└── .github/
    ├── workflows/
    └── PULL_REQUEST_TEMPLATE.md

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

Development Workflow

Branching

  1. Create a feature branch from main:
git checkout -b your-feature-name

  1. Make your changes and ensure all checks pass. See the implementation's README for the exact commands.

  2. Commit with a signed commit.

  3. 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.