docs: add sqlc scripts documentation for developers#1154
Open
EricGrill wants to merge 49 commits into
Open
Conversation
Co-authored-by: Mohamed Awnallah <mohamedmohey2352@gmail.com>
Fixes linting complains "calculated cyclomatic complexity for function UpdateWallet is 12, max is 10 (cyclop)"
This commit adds comprehensive documentation for the SQLC code generation infrastructure used in btcwallet. The guide covers: - Overview of the dual-database (PostgreSQL/SQLite) architecture - Complete directory structure explanation - All Makefile commands for SQL code generation and linting - Step-by-step development workflow for adding queries and migrations - SQL dialect differences between PostgreSQL and SQLite - Integration testing setup and usage - CI/CD pipeline integration details - Common troubleshooting scenarios This documentation addresses issue btcsuite#1109, which was motivated by PR btcsuite#1065 discussions about the need for onboarding documentation for new developers working with the SQL backend. Closes btcsuite#1109 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
yyforyongyu
force-pushed
the
sql-wallet
branch
from
aac7047 to
037828b
Compare
GustavoStingelin
force-pushed
the
sql-wallet
branch
from
037828b to
04b61be
Compare
yyforyongyu
force-pushed
the
sql-wallet
branch
from
bf55cd1 to
2092024
Compare
yyforyongyu
force-pushed
the
sql-wallet
branch
from
2092024 to
a5c3c9e
Compare
yyforyongyu
force-pushed
the
sql-wallet
branch
2 times, most recently
from
8139f20 to
90eaacc
Compare
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
4 participants
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.
Summary
Motivation
This PR addresses issue #1109, which was motivated by PR #1065 discussions about the need for documentation to help new developers understand the SQLC code generation infrastructure.
What's Documented
The new
sqlc_development_guide.mdcovers:Test plan
Closes #1109
Generated with Claude Code