Contributing to ProtoRune

Development Setup

  1. Fork and clone the repository
  2. Install dependencies with mix deps.get
  3. Run tests with mix test

Code Organization 

lib/proto_rune/
├── atproto/      # Core AT Protocol 
├── bsky/         # Bluesky app features
├── bot/          # Bot framework
├── lexicons/     # Generated code
└── xrpc/         # XRPC implementation

Code Style

  • Run mix format before committing
  • Ensure 100% type coverage with dialyzer
  • Keep functions focused and small
  • Document public functions with @doc and @moduledoc
  • Add typespecs to all public functions

Testing

  • Add tests for new features
  • Tests should be in test/ mirroring lib/ structure
  • Run full test suite with mix test
  • Run dialyzer with mix dialyzer

Pull Requests

  1. Create a branch from main
  2. Write descriptive commit messages
  3. Add tests for new functionality
  4. Update documentation as needed
  5. Submit PR with description of changes

PRs should:

  • Have a clear purpose
  • Include relevant tests
  • Pass CI checks
  • Follow code style guidelines
  • Include documentation updates

Generated Code

The lib/proto_rune/lexicons directory contains generated code from AT Protocol lexicons. To regenerate:

mix gen_schemas --path priv/lexicons/ --output lib/proto_rune/lexicons/

Do not modify generated code directly. Update the generator instead.

Release Process

  1. Update version in mix.exs
  2. Update CHANGELOG.md
  3. Create GitHub release
  4. Publish to Hex.pm

Questions?

Open an issue or join the github repo discussion forum.