Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add list of standard checks to docs #1086

Closed
tfwright opened this issue Nov 8, 2023 · 2 comments
Closed

Add list of standard checks to docs #1086

tfwright opened this issue Nov 8, 2023 · 2 comments

Comments

@tfwright
Copy link

tfwright commented Nov 8, 2023

I am actually guessing this is not a bug but I can't find any documentation/explanation around this behavior so I'm reporting it here first just in case.

Based on README my assumption all built in checks are applied and only custom checks, or checks with modified behavior need configuration.

Apologies if I've missed something but if it is expected that there are built in checks that must be included explicitly this should be front and center in the docs and additionally it would be helpful to have an easily accessible list of those checks.

Environment

  • Credo version 1.7

What were you trying to do?

Run credo with all checks (strict)

Expected outcome

All checks applied

Actual outcome

PipeChainStart is not checked unless I add the following to my check config: {Credo.Check.Refactor.PipeChainStart, []}

@rrrene
Copy link
Owner

rrrene commented Dec 17, 2023

Hi, not all checks are enabled by default.

Credo's documentation does not yet provide an overview for which checks are envaled by default 😢

Will use this issue to add that 👍

@rrrene rrrene changed the title PipeChainStart (and others?) not included by default Add list of standard checks to docs Dec 20, 2023
@rrrene
Copy link
Owner

rrrene commented Dec 21, 2023

Added a section "Default Checks" to the Config docs: https://hexdocs.pm/credo/1.7.2-rc.4/config_file.html#default-checks

👍

@rrrene rrrene closed this as completed Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants