Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.98 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.98 KB
Raw

Aqua.jl: Auto QUality Assurance for Julia packages

Stable Dev GitHub Actions Codecov Aqua QA

Aqua.jl provides functions to run a few automatable checks for Julia packages:

  • There are no method ambiguities.
  • There are no undefined exports.
  • There are no unbound type parameters.
  • There are no stale dependencies listed in Project.toml.
  • Check that test target of the root project Project.toml and test project (test/Project.toml) are consistent.
  • Check that all external packages listed in deps have corresponding compat entries.
  • There are no "obvious" type piracies.
  • The package does not create any persistent Tasks that might block precompilation of dependencies.

See more in the documentation.

For a detailed list of changes please refer to the changelog.

Setup

Please consult the stable documentation and the the dev documentation for the latest instructions.

Badge

You can add the following line in README.md to include Aqua.jl badge:

[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

which is rendered as

Aqua QA