Skip to content

Run mix credo on GitHub Actions for Code Consistency 😍 #235

Description

@nelsonic

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. πŸ‘€

Metadata

Metadata

Assignees

Labels

T25mTime Estimate 25 MinutesdocumentationImprovements or additions to documentationelixirPull requests that update Elixir codeenhancementNew feature or enhancement of existing functionalityhelp wantedIf you can help make progress with this issue, please comment!priority-2Second highest priority, should be worked on as soon as the Priority-1 issues are finishedtechnicalA technical issue that requires understanding of the code, infrastructure or dependencies

Type

Projects

Status
Backlog (Prioritized)

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions