Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 853 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 853 Bytes
Raw

Contributing to EdgeAI Telemetry

Development Setup

  1. Clone the repository
  2. Copy .env.example to .env
  3. Run ./scripts/setup.sh

Code Style

Rust Backend

  • Use cargo fmt before committing
  • Run cargo clippy and fix warnings
  • Write tests for new features

Frontend

  • Use npm run lint before committing
  • Follow TypeScript strict mode
  • Use functional components with hooks

Testing

# Backend tests
cd backend && cargo test

# Frontend tests
cd frontend && npm test

# Integration tests
docker-compose -f docker-compose.yml -f docker-compose.test.yml up --abort-on-container-exit

Pull Request Process

  1. Update documentation
  2. Add tests
  3. Update CHANGELOG.md
  4. Request review from maintainers

Security

  • Never commit secrets
  • Report security issues privately
  • Follow security best practices