Introduction

The repo contains custom Credo checks to support Nimble's Elixir conventions.

Project Setup

Erlang & Elixir

• Erlang 25.0.1

• Elixir 1.13.4

• Recommended version manager.

  • asdf
  • asdf-erlang
  • asdf-elixir

Development

• Install Elixir dependencies:

  mix deps.get

• Run all tests:

  mix test 

• Run all lint:

  mix codebase 

• Fix all lint:

  mix codebase.fix 

• Test coverage:

  mix coverage 

CI/CD

The project relies entirely on Github Actions for CI/CD via multiple workflows located under the .github/workflows/ directory.

Please check out the .github/workflows/README.md file for further instructions.