Add notes to homepage linearb by azigler · Pull Request #44 · linearzig/benchmark-ai-code-review

azigler · 2025-06-30T22:51:10Z

LinearB AI Review

Summary by CodeRabbit

New Features
- Introduced a Django starter project including user authentication, custom user model, and admin interface.
- Added home and about pages with basic navigation and custom error pages (403, 404, 500).
- Integrated third-party packages for authentication, form styling, and debugging tools.
- Provided Docker and Docker Compose support for streamlined development and deployment.
- Included a comprehensive README and contributing guidelines.
Style
- Added base CSS for layout, sticky footer, and responsive design.
Documentation
- Added detailed README, LICENSE, and CONTRIBUTING files.
Chores
- Added configuration files for Docker, Git, and project dependencies.
- Set up GitHub Actions workflow for rule evaluation and automation.

This commit sets up a new Django project with: - User authentication via django-allauth - Bootstrap 5 styling and custom CSS - Debug toolbar for development - Docker configuration with PostgreSQL support - Static files handling with WhiteNoise - Custom error pages and base templates

… LinearB!'

…view

This commit introduces a new `add_note` function in the models to manage notes and updates the HomePageView to include a note when the home page is accessed. The home template is also modified to display the notes dynamically.

This commit introduces a new LinearB AI review configuration file and a gitStream workflow automation file. The LinearB configuration triggers code reviews based on specific conditions, while the gitStream workflow automates the evaluation of rules for pull requests, enhancing the CI/CD process.

coderabbitai · 2025-06-30T22:51:17Z

Walkthrough

This update introduces a new Django starter project named "Lithium," adding all foundational files for a modern Django web application. The changes include project configuration, Docker and Compose setup, authentication with a custom user model, static assets, templates for core and error pages, and integration with third-party tools like django-allauth, crispy-forms, and debug-toolbar. Documentation and contribution guidelines are also provided.

Changes

Files/Groups	Change Summary
.cm/linearb.cm, .github/workflows/gitstream.yml	Add automation and workflow files for AI review and GitHub Actions integration.
.dockerignore, .gitignore, Dockerfile, docker-compose.yml	Add Docker-related files and ignore rules for development and deployment.
LICENSE, CONTRIBUTING.md, README.md	Add license, contribution guidelines, and comprehensive project README.
pyproject.toml, requirements.txt	Add Python project dependency and metadata files.
django_project/*, manage.py	Add Django project core files: settings, ASGI/WSGI, URL routing, and management script.
accounts/*	Add custom user model, admin, forms, migration, and placeholder files for a dedicated accounts app.
pages/*	Add basic pages app with view classes, URL routing, models, and placeholder test/admin files.
static/css/base.css	Add base CSS for layout and sticky footer.
templates/*	Add base, error, authentication, and page templates for consistent UI and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant DjangoServer
    participant DB

    User->>Browser: Accesses site ("/", "/about", etc.)
    Browser->>DjangoServer: HTTP Request
    DjangoServer->>DB: (If authentication or data needed)
    DB-->>DjangoServer: Data/User info
    DjangoServer-->>Browser: Rendered HTML (via templates)
    Browser-->>User: Displays page

    User->>Browser: Login/Signup/Password Reset
    Browser->>DjangoServer: POST auth forms
    DjangoServer->>DB: Validate/Create user
    DB-->>DjangoServer: Result
    DjangoServer-->>Browser: Redirect/Render response

Poem

🐰
Lithium springs up, fresh and bright,
Django’s gears now set just right.
With Docker, forms, and pages new,
A starter kit for dreams to pursue.
Hop along, code bunnies, don’t delay—
The project’s ready, up and away!

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

gitstream-cm · 2025-06-30T22:52:21Z

 /:\ gitStream DRY RUN

linearb/linearb_ai_review

• add code-review comment:

✨ PR Review

The PR introduces a comprehensive Django starter project with user authentication and basic functionality. However, there's a critical bug in the add_note function that uses a mutable default argument, which will cause state persistence issues across function calls.

2 issues detected:

🐞 Bug - Using mutable default arguments creates shared state that persists across function calls

Details: The add_note function uses a mutable list as a default argument, which will persist across function calls. This means notes will accumulate between different page visits and user sessions, creating shared state between users.
File: pages/models.py (6-9)

🔒 Security - Hardcoded secret keys in version control expose applications to security attacks

Details: The Django SECRET_KEY is hardcoded in the settings file, which is a security vulnerability. This key should be kept secret and not committed to version control.
File: django_project/settings.py (1-12)

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

To activate these actions - merge this PR into the main branch

Learn more on the gitStream Docs
See your automations on the Usage in LinearB
Create new rules on the gitSteam playground

coderabbitai

Actionable comments posted: 10

🔭 Outside diff range comments (4)

pages/tests.py (1)
1-4: Unused import breaks linters

TestCase is imported but not referenced, triggering F401. Either add tests now or remove the import until needed.
-from django.test import TestCase
-
-# Create your tests here.
+# Tests pending – add cases or keep file empty for now
pages/admin.py (1)
1-4: Remove idle import or silence it

With no models to register, the unused admin import raises F401. Until the app owns models, trim the import or add # noqa: F401.
-from django.contrib import admin
-
-# Register your models here.
+# No models registered yet
accounts/tests.py (1)
1-4: Same unused import issue as in pages/tests.py

The file triggers the same lint failure. Drop the import or write at least one test case.
-from django.test import TestCase
-
-# Create your tests here.
+# Tests pending – add cases or keep file empty for now
templates/pages/home.html (1)
1-22: Improve template formatting for better readability.

While the template functionality is correct, the formatting is compressed and difficult to read. Consider reformatting for better maintainability.

Apply this diff to improve readability:
-{% extends '_base.html' %} {% load static %} {% block title %}Home page{%
-endblock title %} {% block content %}
+{% extends '_base.html' %}
+{% load static %}
+
+{% block title %}Home page{% endblock title %}
+
+{% block content %}
 <div class="pricing-header px-3 py-3 pt-md-5 pb-md-4 mx-auto text-center">
   <img
     src="{% static 'images/lithium.png' %}"
     class="img-fluid"
     alt="Lithium logo"
   />
   <p class="lead">A Django starter project with batteries.</p>
 </div>
 
 {% if notes %}
 <div class="alert alert-info">
   <strong>Notes:</strong>
   <ul>
     {% for note in notes %}
     <li>{{ note }}</li>
     {% endfor %}
   </ul>
 </div>
-{% endif %} {% endblock content %}
+{% endif %}
+{% endblock content %}

🧹 Nitpick comments (17)

.dockerignore (1)
1-2: Consider expanding ignored paths beyond .venv.

Only excluding .venv keeps the build context small, but compiled byte-code (__pycache__/), local .git metadata, and editor swap files will still be sent to Docker unless explicitly ignored. Adding these now saves minutes when the context accidentally balloons later.

Example:
 .venv
+__pycache__/
+*.py[cod]
+.git
+*.swp
CONTRIBUTING.md (1)

3-5: Minor grammar & punctuation nit.

“Thank you for help improving Lithium.” → “Thank you for helping to improve Lithium.”
Missing comma before the coordinating conjunction in “… a PR and I’ll review …”.

Purely editorial; feel free to ignore if house-style differs.
.gitignore (1)
14-18: Add typical secrets & tooling artefacts to .gitignore.

.env, .coverage, .pytest_cache/, and *.sqlite3-journal are common in Django projects and leak easily. Including them early prevents accidental commits.
 media
+.env
+.pytest_cache/
+.coverage
+# SQLite journalling files
+*.sqlite3-journal
static/css/base.css (1)
15-16: Avoid hard-coding footer height in two places

body { margin-bottom: 60px; } and .footer { height: 60px; line-height: 60px; } duplicate the magic number. Any future tweak requires editing three declarations.
+/* Single-source footer height */
+:root {
+  --footer-height: 60px;
+}
 
-body {
-  margin-bottom: 60px; /* Margin bottom by footer height */
-}
+body {
+  margin-bottom: var(--footer-height); /* keep in sync with footer */
+}
 
-.footer {
+.footer {
   position: absolute;
   bottom: 0;
   width: 100%;
-  height: 60px; /* Set the fixed height of the footer here */
-  line-height: 60px; /* Vertically center the text there */
+  height: var(--footer-height); /* read from variable */
+  line-height: var(--footer-height); /* vertical centering */
   background-color: #f5f5f5;
 }
This eliminates repetition and simplifies future maintenance.

Also applies to: 30-32
templates/account/email/password_reset_key_subject.txt (1)
1-1: Subject wording nitpick

Consider dropping the hyphen to align with common usage (“Password Reset Email”).
-Password Reset E-mail
+Password Reset Email
accounts/views.py (1)
1-3: Remove the unused render import or implement a real view

django.shortcuts.render is imported but never used, triggering both Ruff F401 and Flake8 F401.
Either delete the import (simplest) or add a stub view that actually calls render.
-from django.shortcuts import render
-
-# Create your views here.
+# Placeholder until real views are implemented.
+pass
templates/account/password_reset_done.html (1)
2-2: Remove unused {% load crispy_forms_tags %}

crispy_forms_tags isn’t referenced in this template, so the load statement is superfluous.
-{% load crispy_forms_tags %}
accounts/models.py (3)
2-2: Remove unused import.

The django.db.models import is unused and should be removed to clean up the code.
-from django.db import models
4-4: Add missing blank line before class definition.

PEP 8 requires two blank lines before top-level class definitions.
+
 class CustomUser(AbstractUser):
7-8: Consider email validation in str method.

Returning self.email could be problematic if the email field is empty or None. Consider adding a fallback to ensure a meaningful string representation.
 def __str__(self):
-    return self.email
+    return self.email or self.username or f"User {self.pk}"
pages/models.py (1)
1-1: Remove unused import.

The django.db.models import is not used in this file and should be removed to keep the code clean.
-from django.db import models
-
templates/account/password_set.html (1)
11-12: Fix inconsistent button labeling.

The button has inconsistent labeling - the value attribute says "Set Password" but the button text displays "Change Password". This could be confusing for users and developers.
-    <button class="btn btn-primary" type="submit" name="action" value="Set Password">Change
-    Password</button>
+    <button class="btn btn-primary" type="submit" name="action" value="Set Password">Set
+    Password</button>
templates/account/password_reset_from_key.html (1)
22-22: Minor syntax fix needed.

Missing space in the closing block tag.
-{% endblock content%}
+{% endblock content %}
README.md (3)
6-6: Format the bare URL properly.

The GitHub asset URL should be properly formatted as a link or image reference.
-https://github.com/user-attachments/assets/8698e9dd-1794-4f96-9c3f-85add17e330b
+![Lithium Preview](https://github.com/user-attachments/assets/8698e9dd-1794-4f96-9c3f-85add17e330b)
68-68: Fix grammar - missing comma.

Add a comma for better readability.
-To use Docker with PostgreSQL as the database update the `DATABASES` section of `django_project/settings.py` to reflect the following:
+To use Docker with PostgreSQL as the database, update the `DATABASES` section of `django_project/settings.py` to reflect the following:
84-84: Fix grammar - incorrect verb form.

Correct the verb form and word placement.
-The `INTERNAL_IPS` configuration in `django_project/settings.py` must be also be updated:
+The `INTERNAL_IPS` configuration in `django_project/settings.py` must also be updated:
django_project/settings.py (1)

82-87: Database credentials should be environment-driven

Hard-wiring SQLite is fine for quickstarts, but the commented PostgreSQL block
will be forgotten. Consider switching to django-environ or similar so dev,
CI, and prod pick the proper backend automatically.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da7c410 and c5b6e9d.

⛔ Files ignored due to path filters (5)

logo.png is excluded by !**/*.png
static/images/favicon.ico is excluded by !**/*.ico
static/images/lithium.png is excluded by !**/*.png
static/images/logo.png is excluded by !**/*.png
uv.lock is excluded by !**/*.lock

📒 Files selected for processing (47)

.cm/linearb.cm (1 hunks)
.dockerignore (1 hunks)
.github/workflows/gitstream.yml (1 hunks)
.gitignore (1 hunks)
CONTRIBUTING.md (1 hunks)
Dockerfile (1 hunks)
LICENSE (1 hunks)
README.md (1 hunks)
accounts/admin.py (1 hunks)
accounts/apps.py (1 hunks)
accounts/forms.py (1 hunks)
accounts/migrations/0001_initial.py (1 hunks)
accounts/models.py (1 hunks)
accounts/tests.py (1 hunks)
accounts/views.py (1 hunks)
django_project/asgi.py (1 hunks)
django_project/settings.py (1 hunks)
django_project/urls.py (1 hunks)
django_project/wsgi.py (1 hunks)
docker-compose.yml (1 hunks)
manage.py (1 hunks)
pages/admin.py (1 hunks)
pages/apps.py (1 hunks)
pages/models.py (1 hunks)
pages/tests.py (1 hunks)
pages/urls.py (1 hunks)
pages/views.py (1 hunks)
pyproject.toml (1 hunks)
requirements.txt (1 hunks)
static/css/base.css (1 hunks)
templates/403_csrf.html (1 hunks)
templates/404.html (1 hunks)
templates/500.html (1 hunks)
templates/_base.html (1 hunks)
templates/account/email/password_reset_key_message.txt (1 hunks)
templates/account/email/password_reset_key_subject.txt (1 hunks)
templates/account/login.html (1 hunks)
templates/account/logout.html (1 hunks)
templates/account/password_change.html (1 hunks)
templates/account/password_reset.html (1 hunks)
templates/account/password_reset_done.html (1 hunks)
templates/account/password_reset_from_key.html (1 hunks)
templates/account/password_reset_from_key_done.html (1 hunks)
templates/account/password_set.html (1 hunks)
templates/account/signup.html (1 hunks)
templates/pages/about.html (1 hunks)
templates/pages/home.html (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (4)

accounts/forms.py (1)

accounts/models.py (1)

CustomUser (4-8)

accounts/admin.py (2)

accounts/forms.py (2)

CustomUserCreationForm (5-12)

CustomUserChangeForm (15-22)

accounts/models.py (1)

CustomUser (4-8)

pages/urls.py (1)

pages/views.py (2)

HomePageView (5-12)

AboutPageView (15-16)

pages/views.py (1)

pages/models.py (1)

add_note (6-11)

🪛 Ruff (0.11.9)

pages/admin.py

1-1: django.contrib.admin imported but unused

Remove unused import: django.contrib.admin

(F401)

accounts/tests.py

1-1: django.test.TestCase imported but unused

Remove unused import: django.test.TestCase

(F401)

pages/tests.py

1-1: django.test.TestCase imported but unused

Remove unused import: django.test.TestCase

(F401)

accounts/models.py

2-2: django.db.models imported but unused

Remove unused import: django.db.models

(F401)

pages/models.py

1-1: django.db.models imported but unused

Remove unused import: django.db.models

(F401)

6-6: Do not use mutable data structures for argument defaults

Replace with None; initialize within function

(B006)

accounts/views.py

1-1: django.shortcuts.render imported but unused

Remove unused import: django.shortcuts.render

(F401)

🪛 Flake8 (7.2.0)

pages/admin.py

[error] 1-1: 'django.contrib.admin' imported but unused

(F401)

accounts/tests.py

[error] 1-1: 'django.test.TestCase' imported but unused

(F401)

pages/tests.py

[error] 1-1: 'django.test.TestCase' imported but unused

(F401)

accounts/models.py

[error] 2-2: 'django.db.models' imported but unused

(F401)

[error] 4-4: expected 2 blank lines, found 1

(E302)

pages/models.py

[error] 1-1: 'django.db.models' imported but unused

(F401)

accounts/views.py

[error] 1-1: 'django.shortcuts.render' imported but unused

(F401)

🪛 HTMLHint (1.5.0)

templates/404.html