dwyl/learn-elixir

Run `mix credo` on `GitHub Actions` for Code Consistency 😍

Open

#235 opened on Jul 29, 2026

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Elixir (113 forks)batch import
T25mdocumentationelixirenhancementhelp wantedpriority-2technical

Repository metrics

Stars
 (1,695 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Context

We have used 3rd party code quality badges e.g. CodeClimate in the past. But haven't applied them to our Elixir projects ... until now! 🤷‍♂️

Example

while reading: https://github.com/cesium/safira discovered via @ruilopesm & @nelsonmestevao 🫶

we see they have the following badge: code quality prominently displayed:

The action is: /cesium/safira/.github/workflows/style.yml

Note: we are using credo in several projects e.g: mvp just not running the mix task on GitHub Actions or displaying a badge for "Code Quality".

Todo ✅

  • Document the setup steps in a code-style.md file in this (/learn-elixir) repo. 📝
    • Create PR here in /learn-elixir 🆕
  • Add it to at least one repo, e.g: fields 🌻
  • Run the mix credo --all --strict on localhost to ensure it passes; 💻
    • Make any necessary changes. 🛠️
  • Add a flat-square badge to the repo. 🏷️
  • Create PR in the repo where the style.yml task is being added. :shipit:
  • Submit for review. 👀

Contributor guide

Research direction
Review the example GitHub Actions workflow in the cesium/safira repository to understand how to run mix credo on Elixir projects. Learn how to add a code quality badge to the README and check the project's mix.exs for credo configuration.
Tech stack
elixirgithub actions
Domain
ci cdtooling
Issue type
DevOps
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitElixir
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75