Packages

usage_rules

1.0.2
1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.0 1.0.3 1.0.2 1.0.1 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

A config-driven dev tool for Elixir projects to manage AGENTS.md files and agent skills from dependencies

HexDocs

Current section

Files

Jump to
Readme
42 Versions
3 Dependencies
Dependants
Files
Activity
usage_rules usage-rules otp.md
Raw

usage-rules/otp.md 

# OTP Usage Rules



## GenServer Best Practices

- Keep state simple and serializable

- Handle all expected messages explicitly

- Use `handle_continue/2` for post-init work

- Implement proper cleanup in `terminate/2` when necessary



## Process Communication

- Use `GenServer.call/3` for synchronous requests expecting replies

- Use `GenServer.cast/2` for fire-and-forget messages.

- When in doubt, use `call` over `cast`, to ensure back-pressure

- Set appropriate timeouts for `call/3` operations



## Fault Tolerance

- Set up processes such that they can handle crashing and being restarted by supervisors

- Use `:max_restarts` and `:max_seconds` to prevent restart loops



## Task and Async

- Use `Task.Supervisor` for better fault tolerance

- Handle task failures with `Task.yield/2` or `Task.shutdown/2`

- Set appropriate task timeouts

- Use `Task.async_stream/3` for concurrent enumeration with back-pressure