docs: update backend database schema section in README#232
Open
CodeSparks45 wants to merge 1 commit into
Open
Conversation
|
🎉 Thank you @CodeSparks45 for submitting a Pull Request! We're excited to review your contribution. Before Review✅ Ensure all CI checks pass ⚡ Want faster reviews and contributor support? Join our Discord community: 🔗 https://discord.gg/FcXuyw2Rs Maintainers and mentors are active there and can help resolve blockers quickly. Happy Contributing! 🚀 |
|
✅ PR template check passed! @arpit2006 this PR is ready for your review. 🚀 |
Signed-off-by: CodeSpark45 <somvanshipavan2006@gmail.com>
arpit2006
requested changes
Jun 28, 2026
arpit2006
left a comment
Collaborator
There was a problem hiding this comment.
@CodeSparks45 !
Create a docs folder and create this database.md in there and link it on readme to ensure good experience.
arpit2006
requested changes
Jun 28, 2026
arpit2006
left a comment
Collaborator
There was a problem hiding this comment.
Create folder and add it there
Collaborator
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
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.
Linked issue
Closes #214
What this PR does
This PR synchronizes the database schema documentation in
backend/README.mdwith the actual SQLite implementation found inbackend/app/db.py. It comprehensively documents all six actively initialized tables along with their respective column types, descriptions, and foreign key relationships to eliminate documentation drift.Type of change
ML tier (if applicable)
Stack affected
Changes
Backend
## Database Schemasection inbackend/README.mdwith accurate markdown tables representing the current database state.Frontend
New dependencies
Database / schema changes
org_jobs,verify_outcomes,contributor_stats,dependency_links).package_name,ml_score,false_positiveinfindings).Testing
How did you test this?
Performed a manual cross-reference between the SQL
CREATE TABLEandALTER TABLEexecution queries inbackend/app/db.pyand the newly formatted markdown tables. Rendered the markdown locally in VS Code to ensure standard GitHub Flavored Markdown (GFM) table formatting is visually intact and readable.Checklist
console.erroror unhandled Python exceptions introducedrequirements.txt/package.jsonupdated if new dependencies added.pkl,.pt, etc.) are gitignored, not committedAnything reviewers should focus on
No complex logic changes. Please verify that the documented columns align exactly with the current
db.pyinitialization logic.Screenshots (if UI changed)