local-it/mitgliederverwaltung
2
3
Fork 0
Code Issues 51 Pull requests 13 Projects 1 Releases Packages 1 Activity Actions

docs: enable Credo ModuleDoc check and fix remaining modules

Browse source 
Add @moduledoc to Secrets, LiveHelpers, AuthOverrides, and Membership domain.
Enable Credo.Check.Readability.ModuleDoc in .credo.exs.
This commit is contained in:
Moritz 2025-11-10 16:30:14 +01:00
parent 6922086fa1
commit 150bba2ef8
Signed by: moritz
GPG key ID: 1020A035E5DD0824
6 changed files with 69 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CODE_GUIDELINES.md
View file

@ -917,14 +917,16 @@ mix credo --strict
- Consistency checks (spacing, line endings, parameter patterns)
- Design checks (FIXME/TODO tags, alias usage)
- Readability checks (max line length: 120, module/function names)
- Readability checks (max line length: 120, module/function names, **module documentation**)
- Refactoring opportunities (cyclomatic complexity, nesting)
- Warnings (unused operations, unsafe operations)
**Disabled Checks:**
**Documentation Enforcement:**
- `Credo.Check.Readability.ModuleDoc` - Disabled by team decision
(Still encouraged to add module docs for public modules)
- ✅ `Credo.Check.Readability.ModuleDoc` - **ENABLED** (as of November 2025)
- All modules require `@moduledoc` documentation
- Current coverage: 51 @moduledoc declarations across 47 modules (100% core modules)
- CI pipeline enforces documentation standards
**Address Credo Issues:**