Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (43 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 1.75 KB

Contributing to Stellarcade

Thanks for contributing to Stellarcade.

How to Contribute

  1. Find an issue to work on.
  2. Fork and clone the repository.
  3. Create a focused branch for your work.
  4. Implement the change and add or update tests.
  5. Run the local checks.
  6. Open a pull request against main.

Development Setup

Smart Contracts

  • Install Rust.
  • Install Soroban CLI: cargo install --locked soroban-cli
  • Run tests in the touched crate with cargo test.

Backend

  • Install Node.js.
  • Install dependencies with cd backend && npm install.
  • Start the dev server with npm run dev.

Frontend

  • Install Node.js.
  • Install dependencies with cd frontend && npm install.
  • Start the dev server with npm run dev.

Infrastructure

  • Install Docker and Docker Compose.
  • Start local services with docker-compose up -d.

Git Hooks

  • Enable the shared repo hooks right after cloning.
  • macOS/Linux: bash scripts/setup-hooks.sh
  • Windows PowerShell: powershell -ExecutionPolicy Bypass -File scripts/setup-hooks.ps1
  • Verify the setup with git config --get core.hooksPath
  • The hooks catch common contract, backend, and frontend failures before push.

Code Style

  • JavaScript and TypeScript: follow the ESLint configuration.
  • Rust: use snake_case and run cargo fmt.
  • SQL: use snake_case for table and column names.

Pull Request Process

  • Keep each PR focused on one change area.
  • Update docs when behavior changes.
  • Run the repo hooks before pushing so CI failures are caught locally.
  • Ensure CI checks pass before requesting review.

Issue Reporting

  • Use the issue templates in .github/ISSUE_TEMPLATE/.
  • Include reproduction steps for bugs and exact scope for features.