Verified:GitHub

elixir-guidelines

Standardize Elixir codebases with official naming, structure, and documentation standards.

1|1|Updated Jan 3, 2026

Search Tags:#documentation #elixir #naming-conventions #project-structure #code-style #library-publishing #module-naming

Ready to run

npx skills add https://github.com/layeddie/ai-rules --skill elixir-guidelines

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: elixir-guidelines
Source: https://github.com/layeddie/ai-rules/tree/main/skills/elixir-guidelines
Command: npx skills add https://github.com/layeddie/ai-rules --skill elixir-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Official Elixir community standards, naming conventions, and best practices to ensure consistent and idiomatic code across projects.

Core Features & Use Cases

Naming conventions for projects, modules, functions, and variables to promote readability and consistency.
Code style guidance, including pipe usage, pattern matching, and documentation practices.
Library publishing and project structure guidelines aligned with Hex.pm expectations.
Real-world use: when starting a new Elixir library or application, apply these standards to accelerate onboarding and maintain quality.

Quick Start

Ask me to generate idiomatic Elixir module names, project structure, and documentation guidelines for a new library.

Frequently Asked Questions about elixir-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What are the Elixir naming conventions for modules and functions?▼

Elixir naming conventions standardize module, function, and variable names to promote readability and consistency across projects. Following official community guidelines ensures idiomatic code structure and predictable API design for libraries and applications.

How do I structure a new Elixir library project for Hex.pm?▼

To structure a new Elixir library for Hex.pm, apply official project layout and publishing guidelines that define directory organization and configuration. This ensures your package meets community expectations and integrates smoothly with the Hex ecosystem.

What is the best way to write Elixir documentation with @moduledoc?▼

The best way to write Elixir documentation with @moduledoc is to follow official documentation practices that enforce clear module descriptions and usage examples. Proper @moduledoc usage accelerates onboarding and maintains codebase quality.

Does this Elixir style guide cover pipe operator usage and pattern matching?▼

Yes, this Elixir style guide covers pipe operator usage and pattern matching as core components of code style guidance. It provides rules for applying these features idiomatically to keep your codebase readable and consistent.

When should I apply Elixir community standards to my codebase?▼

You should apply Elixir community standards when creating new Elixir projects, libraries, or APIs to ensure consistent module naming and project architecture. Enforcing these standards early accelerates onboarding and maintains long-term quality.