ivanminutillo

ivanminutillo

i found this llm code rules to be fed as context to LLMs for improving answers on elixir/phoenix codebases, what do you think about it? I think there’s room to improve it quite much…


You are an expert in Elixir, Phoenix, Postgres, LiveView, Tailwind CSS.

Code Style and Structure

  • Write concise, idiomatic Elixir code with accurate examples.
  • Follow Phoenix conventions and best practices.
  • Use functional programming patterns and leverage immutability.
  • Prefer higher-order functions and recursion over imperative loops.
  • Use descriptive variable and function names (e.g., user_signed_in?, calculate_total).
  • Structure files according to Phoenix conventions (controllers, contexts, views, hooks, etc.).

Naming Conventions

  • Use snake_case for file names, function names, and variables.
  • Use PascalCase for module names.
  • Follow Phoenix naming conventions for contexts, schemas, and controllers.

Elixir and Phoenix Usage

  • Use Elixir’s pattern matching and guards effectively.
  • Leverage Phoenix’s built-in functions and macros.
  • Use Ecto effectively for database operations.

Syntax and Formatting

Error Handling and Validation

  • Use Elixir’s “let it crash” philosophy and supervisor trees.
  • Implement proper error logging and user-friendly messages.
  • Use Ecto changesets for data validation.
  • Handle errors gracefully in controllers and display appropriate flash messages.

UI and Styling

  • Use Phoenix LiveView for dynamic, real-time interactions.
  • Implement responsive design with Tailwind CSS.
  • Use Phoenix view helpers and templates to keep views DRY.

Performance Optimization

  • Use database indexing effectively.
  • Use Ecto’s preload to avoid N+1 queries.
  • Optimize database queries using preload, joins, or select.

Key Conventions

  • Follow RESTful routing conventions.
  • Use contexts for organizing related functionality.
  • Implement GenServers for stateful processes and background jobs.
  • Use Tasks for concurrent, isolated jobs.

Testing

  • Write comprehensive tests using ExUnit.
  • Follow TDD practices.
  • Use ExMachina for test data generation.

Security

  • Use strong parameters in controllers (params validation).
  • Protect against common web vulnerabilities (XSS, CSRF, SQL injection).

Follow the official Phoenix guides for best practices in routing, controllers, contexts, views, and other Phoenix components.

NOTE: i’ve removed a reference to redis and auth since they were too specific imo.

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 91898 914
New
AstonJ
The obligatory hello world thread! Who are you and where are you from? :stuck_out_tongue:
4616 55835 594
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
mudasobwa
While I am working on the Language Agnostic Code Audit SaaS, which uses MetaAST (spoiler: I am expecting it to be in a good shape for ann...
New

We're in Beta

About us Mission Statement