dwyl/learn-elixir

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

Aberta

#235 aberto em 29 de jul. de 2026

Ver no GitHub
 (1 comentário) (0 reação) (1 responsável)Elixir (113 forks)batch import
T25mdocumentationelixirenhancementhelp wantedpriority-2technical

Métricas do repositório

Stars
 (1.695 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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. 👀

Guia do colaborador

Direção de pesquisa
Analise o fluxo de trabalho do GitHub Actions de exemplo no repositório cesium/safira para entender como executar o mix credo em projetos Elixir. Aprenda como adicionar um selo de qualidade de código ao README e verifique o mix.exs do projeto para a configuração do credo.
Pilha de tecnologia
elixirgithub actions
Domain
ci cdtooling
Tipo Issue
DevOps
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitElixir
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75