django-cms/djangocms-stories
Grade a repo

0

/ 100

GradeB

Solid foundation. Invest in docs and CI to grow from here.

Top 32% of 5,156 graded repos

django CMS stories application - Tell your story in multilingual posts, using the full power of django CMS placeholders.

Documentation70
Engineering80
Health98
Python18BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

17 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

70

README12pt40

README is present.

Contributing guide5pt67

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

80

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.

Reproducibility6pt70

Lockfile present (docs/requirements.txt). Installs are reproducible.

CI/CD14pt85

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

Tests18pt100

Test files detected (tests).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Project health

98

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

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)
  • 7
    Forks
  • 15
    Releaseslatest 11mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 18
    Watchers

Responsiveness

  • 8d 16h
    Median issue response
  • 1h
    Median PR merge time
  • 7
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
  • .tx
  • djangocms_blog
  • djangocms_stories
  • docs
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • .readthedocs.yml
  • CHANGELOG.rst
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.rst
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    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.
    Good: README documents how to run the project.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/django-cms/djangocms-stories)](https://www.repo-grade.com/report/django-cms/djangocms-stories)

More graded Python repos