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 92995 915
New
caslu
I want to open this thread for you all to discuss and help those who really like Ash but are still hesitant to use it in a real project. ...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
GES233
I’m posting this in response to Jose’s recent tweet (Cr. link) : People are sleeping on Elixir for a coding harness: Hot-code swappi...
New
_mfierro
Hello, I wrote Stop My Hand, a Scattergories-like web application using Phoenix/LiveView as my learning project for Elixir (after readin...
New
marciol
It would be helpful to have a list of companies worldwide that hire engineers without prior experience in Elixir. Often, it can be quite ...
New
durvia
Anyone running long-lived stateful processes on BEAM? We’re building an AI agent runtime and would love to compare notes. We’re a small ...
New

Other Trending Topics Top

garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
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
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
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
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews