kgrzybek/modular-monolith-with-ddd

0

/ 100

Documentation82
Engineering57
Health75
C#13,771MIT2y ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

Full Modular Monolith application with Domain-Driven Design approach.

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

57

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Enable and commit packages.lock.json so NuGet restores are repeatable.

CI/CD14pt57

CI is configured (.github/workflows/buildPipeline.yml).

Tests18pt80

Test files detected (build/BuildIntegrationTests.cs).

Linting and formatting5pt100

.NET formatting configured (build/.editorconfig).

Project health

75

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Dependency manifest6pt100

Dependency manifest found (build/_build.csproj).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/buildPipeline.yml).
  • .nuke
  • build
    Good: Test files detected (build/BuildIntegrationTests.cs).
    Good: .NET formatting configured (build/.editorconfig).
    Good: Dependency manifest found (build/_build.csproj).
  • docs
  • src
  • .gitignore
    Good: .gitignore present.
  • azure-pipelines.yml
  • build.cmd
  • build.ps1
  • build.sh
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • runIntegrationTests.cmd