Entrega 2 — JCM - #241
Open
jnchacon wants to merge 2 commits into
Open
Conversation
Fill in readme.md template with: - Project card (Components DB - electrical components catalog) - Product description (objectives, features, installation) - Architecture (C4 diagrams, monolithic Django, HTMX+Alpine.js) - Data model (15-entity ERD with EAV typed columns) - API specification (3 key endpoints: search, HTMX partials, JSON) - User stories (3: create component, parametric search, register offer) - Work tickets (3: backend service, frontend HTMX form, DB models) - Pull requests (3: #1 PRD, LIDR-academy#3 scaffold, LIDR-academy#6 dev environment) Fill in prompts.md with key prompts from 11 development sessions covering product definition, architecture decisions, data modeling, API design, and implementation planning.
📝 WalkthroughWalkthroughprompts.md and readme.md were both rewritten from placeholder templates into detailed, section-by-section documentation of prompts used across the project lifecycle: idea definition, PRD, architecture, data model, API spec, user stories, MVP tickets, and AI extraction features. No code entities changed. ChangesPrompt documentation update
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
readme.md (1)
25-253: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winLabel the fenced snippets with a language.
These fences are all unlabeled, so
markdownlintwill keep flagging MD040. Please tag prose blocks astextand the few command/diagram snippets asbashormermaidso the doc stays lint-clean and easier to scan.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@readme.md` around lines 25 - 253, The readme has multiple fenced code blocks without language tags, which triggers markdownlint MD040. Update each fenced snippet in the document by adding the appropriate language identifier based on its content: use text for narrative/prose examples, bash for shell-style prompts/commands, and mermaid for diagrams. Focus on the unlabeled fences in the sections describing the `/define-idea`, `/create-prd`, `/create-srs`, architecture, ERD, routes, and sequence diagrams so the markdown stays lint-clean and easier to scan.Source: Linters/SAST tools
prompts.md (1)
25-253: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winLabel the fenced snippets with a language.
These fences are all unlabeled, so
markdownlintwill keep flagging MD040. Please tag prose blocks astextand the few command/diagram snippets asbashormermaidso the doc stays lint-clean and easier to scan.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@prompts.md` around lines 25 - 253, The fenced snippets in this document are missing language tags, which triggers markdownlint MD040. Update each unlabeled fence in the affected prompts/sections to use the appropriate language marker: prose examples as text, shell-style commands as bash, and architecture/sequence snippets as mermaid. Keep the content unchanged and ensure the labels are applied consistently across the /define-idea, /create-prd, /create-srs, and implementation example blocks so the file stays lint-clean.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@prompts.md`:
- Around line 25-253: The fenced snippets in this document are missing language
tags, which triggers markdownlint MD040. Update each unlabeled fence in the
affected prompts/sections to use the appropriate language marker: prose examples
as text, shell-style commands as bash, and architecture/sequence snippets as
mermaid. Keep the content unchanged and ensure the labels are applied
consistently across the /define-idea, /create-prd, /create-srs, and
implementation example blocks so the file stays lint-clean.
In `@readme.md`:
- Around line 25-253: The readme has multiple fenced code blocks without
language tags, which triggers markdownlint MD040. Update each fenced snippet in
the document by adding the appropriate language identifier based on its content:
use text for narrative/prose examples, bash for shell-style prompts/commands,
and mermaid for diagrams. Focus on the unlabeled fences in the sections
describing the `/define-idea`, `/create-prd`, `/create-srs`, architecture, ERD,
routes, and sequence diagrams so the markdown stays lint-clean and easier to
scan.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Entrega 2 — Código funcional (primer MVP ejecutable)
Alumno: Juan Andrés Chacón Matteo
Proyecto: Components DB — Catálogo Estructurado de Componentes Eléctricos
Contenido de readme.md y prompts.md actualizado
Repositorio del proyecto
https://github.com/jnchacon/components-db/tree/feature-entrega2-JCM (privado, ya compartido con la TA)