Repository navigation
Conversation
developer_guide.adoc is SQL and PL reference material, and the contribution guide covers the CLA, commit style and how to send a patch, but nothing explains how to build the tree or run the test suites. A new contributor has to reverse-engineer that from configure --help and the CI workflows. Add master/contribution/developer_workflow.adoc in CN and EN, plus one navigation entry per language, covering: - prerequisites, including why the tests must not run as root (initdb refuses to run as root, which is the first thing that breaks inside a container); - configure, the --with-uuid=bsd|e2fs|ossp requirement and what happens when it is omitted (configure silently sets with_uuid=no and the build stops at contrib/uuid-ossp with an #error), and --enable-tap-tests; - initializing an instance in both compatible modes, and what initdb -L does and does not change: it overrides the input files initdb reads, but CREATE EXTENSION during bootstrap still resolves against the compiled-in SHAREDIR; - three test tiers (TAP, core regression, Oracle-compatible regression), noting that the shared TAP template initializes in pg mode, so Oracle mode coverage has to bring its own instance; - sending a patch: commit message style, the AI-assistance trailer, and the CLA. The TAP transcript quoted on the page is a real 5.6 run; the two other tiers are documented as commands only, because they were not measured when the page was written.
|
🚀 IvorySQL-Docs Preview Ready
|
Author
|
CI is green and the rendered result has been verified on the deploy preview.
Nothing else is pending on my side -- happy to adjust wording or split anything if you prefer a different shape for this section. |
qwer381
force-pushed
the
docs/developer-workflow
branch
from
November 13, 2026 05:53
d91289d to
cb083e0
Compare
|
🚀 IvorySQL-Docs Preview Ready
|
This branch was previously deployed
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.
Closes #385
What this changes
New page
CN|EN/modules/ROOT/pages/master/contribution/developer_workflow.adoc(290 lines each) plus one line in eachnav.adoc, inserted right after the contribution guide entry:nav.adoc: after** xref:master/contribution/contribution_guide.adoc[贡献指南]nav.adoc: after** xref:master/contribution/contribution_guide.adoc[Contribution Guide]The page covers the path from a clean checkout to an accepted patch:
root(initdb: error: cannot be run as root).configure, the--with-uuid=bsd|e2fs|ossprequirement and what happens when it is omitted,make,make install, and--enable-tap-tests.initdb -m oraclevs-m pg, the relationship between Oracle mode and theuuid-osspextension, and whatinitdb -Ldoes and does not change (-Loverrides the input files initdb reads;CREATE EXTENSIONduring bootstrap still resolves against the compiled-inSHAREDIR, so-Lcannot be used to point at a temporary extension directory).make -C <dir> check), core regression, and the Oracle-compatible regression target, with the note that the shared TAP template initializes inpgmode, so Oracle-mode coverage has to bring its own instance.git format-patch/git send-email, and the CLA.--with-uuid, no TAP prerequisites, running as root, Oracle-mode tests failing because the extension is absent).How it was verified
The TAP transcript quoted in the page is a real run on IvorySQL 5.6:
The
configureexcerpts come fromconfigure --helpof the same tree, and the#errorpath was reproduced by building with--with-uuidomitted.Two tiers are not run in this batch, and the page says so explicitly instead of pasting output: core regression (
make check) and the Oracle-compatible regression target. They are documented as commands with a note that the output is environment-dependent.Rendering: both languages convert with
asciidoctor.js 4.2.1, zero warnings, identical heading structure (= ×1,== ×8,=== ×16,==== ×1).Checklist
nav.adocchange is a single inserted line per language, no reordering