freddy-dk/fkh

0

/ 100

Documentation52
Engineering21
Health100
C#21Other1d ago
Grade a repo

Some interest. A stronger README and CI would help.

Freddy's Kubernetes Helper lets authorised GitHub users work with Business Central containers and perform developer tasks on demand - directly from VS Code, a CLI, or GitHub Actions workflows. A GitHub-authenticated Azure Function acts as the provisioning gate; Terraform manages all Azure and Kubernetes infrastructure.

Documentation

52

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 instructions9pt45

README documents how to install the project.

README12pt55

README is present.

License6pt100

Licensed under Other.

Engineering

21

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Linting and formatting5pt0

No .NET formatter configured.

→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.

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.

CI/CD14pt40

CI is configured (.github/workflows/CI.yaml).

Reproducibility6pt80

Lockfile present (fkh-vsix/package-lock.json). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (fkh-backend/azure-function.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 9
    Forks
  • 10
    Releaseslatest 1d ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 21
    Watchers

Responsiveness

  • 4h
    Median issue response
  • 5h
    Median PR merge time
  • 13
    Open issues
Repository files21 root entries
  • .github
    Good: CI is configured (.github/workflows/CI.yaml).
  • ContainerScripts
  • deployment-repo
  • fkh-backend
    Good: Dependency manifest found (fkh-backend/azure-function.csproj).
  • fkh-cli
  • fkh-vsix
    Good: Lockfile present (fkh-vsix/package-lock.json). Installs are reproducible.
  • fkh-web
  • Installation
  • mssql-fts
    Good: Environment pinned via mssql-fts/Dockerfile.
  • terraform
  • .gitignore
    Good: .gitignore present.
  • AadAuthentication.md
  • AGENTS.md
  • Architecture.md
  • CheatSheet.md
  • EndUserSetup.md
  • fkh.code-workspace
  • LICENSE
    Good: Licensed under Other.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • Support Service Agreement.md
  • SupportedClientVersions.json