Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.04 KB
Raw

Contributing to Heim

Thank you for your interest in contributing to Heim! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/heim.git
  3. Create a branch: git checkout -b feature/my-feature
  4. Make your changes
  5. Run tests: go test ./...
  6. Commit: git commit -m "feat: add my feature"
  7. Push: git push origin feature/my-feature
  8. Open a Pull Request

Development Setup

Prerequisites

  • Go 1.23+
  • Node.js 20+ (for web UI)
  • SQLite 3

Running Locally

# Backend
go run ./cmd/heim serve --dev

# Frontend
cd web && npm install && npm run dev

Code Style

  • Go: Follow standard Go conventions, use gofmt
  • TypeScript: ESLint + Prettier
  • Commit messages: Conventional Commits

Architecture

See architecture.md for system design details.

License

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