Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (66 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

98 lines (66 loc) · 1.5 KB

Contributing to CryptoServe

Thank you for your interest in contributing to CryptoServe!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/cryptoserve.git
  3. Create a branch: git checkout -b feature/your-feature

Development Setup

Prerequisites

  • Python 3.12+
  • Node.js 20+
  • Docker and Docker Compose
  • PostgreSQL (or use Docker)

Backend

cd backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

# Start PostgreSQL
docker compose up -d postgres

# Run server
uvicorn app.main:app --reload

Frontend

cd frontend
npm install
npm run dev

SDK

cd sdk/python
pip install -e .

Code Style

Python

  • Use type hints
  • Format with black
  • Lint with ruff
  • Sort imports with isort

TypeScript

  • Use strict mode
  • Format with Prettier
  • Lint with ESLint

Testing

Backend Tests

cd backend
pytest

Frontend Tests

cd frontend
npm test

Pull Request Process

  1. Ensure tests pass
  2. Update documentation if needed
  3. Add a clear description of changes
  4. Reference any related issues

Security

If you discover a security vulnerability, please do NOT open a public issue. Instead, email security@example.com with details.

Code of Conduct

Be respectful and inclusive. We welcome contributors of all backgrounds.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.