Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
150 lines (105 loc) · 4.56 KB

CONTRIBUTING.md

File metadata and controls

150 lines (105 loc) · 4.56 KB
Raw

Contributing to stellarGive

Thanks for contributing to stellarGive! This repository contains:

  • Soroban contract: contracts/stellar-give
  • Next.js frontend: frontend

1. Branch Strategy

Use prefixed branch names:

  • feat/<short-description> for features
  • fix/<short-description> for bug fixes
  • chore/<short-description> for maintenance

Examples:

  • feat/campaign-filtering
  • fix/claim-deadline-validation
  • chore/ci-cache-tuning

2. Local Setup

Frontend Setup (Node.js)

We enforce a consistent Node.js version using .nvmrc located in the frontend directory.

git clone https://github.com/Feyisara2108/stellargive.git
cd stellargive

# Set up the frontend
cd frontend
nvm use # Uses the version specified in .nvmrc
npm ci
cp .env.example .env.local

Contract Setup (Rust & Soroban)

# Install the Rust toolchain
rustup toolchain install stable
rustup target add wasm32-unknown-unknown

# Install Soroban CLI
cargo install --locked soroban-cli

3. Testing Requirements

Before opening a PR, ensure all local checks pass:

# Contract checks
cd contracts/stellar-give
cargo fmt --check
cargo clippy -- -D warnings
cargo test
cargo build --release --target wasm32-unknown-unknown

# Frontend checks
cd ../../frontend
npm run lint
npm run build
npm run test

4. Code Review Standards

  • Keep PRs focused and scoped to a single concern.
  • Include tests or rationale when changing contract logic.
  • Do not merge with failing CI.
  • Document config/deployment changes in docs/DEPLOYMENT.md.
  • Flag security-sensitive changes explicitly in PR description.

5. Commit Message Convention

We use Conventional Commits. Your commit messages should reflect the branch strategy:

  • feat: add campaign claim guard
  • fix: enforce accepted token check
  • chore: optimize frontend ci cache

6. Required CI Checks

When you open a PR, the following automated checks must pass before merging:

  • Contract Tests: Runs cargo test and coverage reports. (ci-contract.yml)
  • Lint & Format: Runs cargo fmt, cargo clippy, and eslint. (ci-lint.yml)
  • Frontend Build: Ensures Next.js compiles without errors. (ci.yml)

7. Good First Issues

If you're looking for a place to start, check out the good first issue label on our issue tracker. These are self-contained tasks that are perfect for getting familiar with the codebase!

8. Templates

When contributing, please follow our Pull Request Template to provide context and verification steps. If you are creating an issue, please provide clear reproduction steps for bugs or detailed use cases for feature requests.

Pull Request Template (Use in every PR)

## Summary
- What changed and why

## Type of change
- [ ] feat
- [ ] fix
- [ ] chore
- [ ] docs

## Validation
- [ ] cargo fmt --check
- [ ] cargo clippy -- -D warnings
- [ ] cargo test
- [ ] npm run lint
- [ ] npm run build

## Mainnet Readiness (Required for Mainnet-targeting PRs)
- [ ] [Final Mainnet Audit Checklist](../docs/MAINNET_AUDIT_CHECKLIST.md) completed and signed off.

## Security impact
- [ ] No security impact
- [ ] Security-sensitive (describe)

## Deployment notes
- Any testnet/mainnet rollout steps

9. Pre-commit Hooks

We use Husky and lint-staged to automatically format and lint modified files before every commit. The hook runs only on staged files for speed.

What runs:

  • Frontend files (frontend/**/*.{js,jsx,ts,tsx}): Prettier formats and ESLint fixes
  • Rust files (contracts/**/*.rs): cargo fmt formats the code

Setup: Run npm run prepare at the repository root to initialize the hooks.

Emergency skip: Use git commit --no-verify to bypass the hook when necessary.

10. EditorConfig

An .editorconfig file enforces consistent formatting across editors (UTF-8, LF line endings, trailing whitespace trimming, and indentation per file type). Most editors respect it automatically; install a plugin if yours doesn't.

11. Secret Scanning

Gitleaks runs on every PR and push to main to prevent committed secrets. If a scan flags a false positive, add an allowlist entry in .gitleaks.toml with a comment explaining why.

12. Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating you are expected to uphold this code. Please report unacceptable behavior to stellargive-conduct@proton.me.