docs: expand CONTRIBUTING.md with technical developer workflow#6
Draft
patty-chow wants to merge 1 commit into
Draft
docs: expand CONTRIBUTING.md with technical developer workflow#6patty-chow wants to merge 1 commit into
patty-chow wants to merge 1 commit into
Conversation
Add a Developer Workflow section covering: - Dev container setup (VS Code + .devcontainer) and Build-from-source pointer - Repository layout with component relationships diagram - Build instructions for C extensions and Rust gateway, incl. DEBUG flag - Running C regression tests (check, check-minimal, check-extended-rum, check-isolation, check-valgrind) - Running Rust gateway unit and integration tests - Running the functional test gate (allowlist/single/full) - Step-by-step guide for adding features and fixing bugs with C extension and Rust-specific conventions Existing community process content (asking questions, reporting issues, DCO, TSC) is preserved unchanged. Added a table of contents. Signed-off-by: richardsimmonds <richardsimmonds314@gmail.com>
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
2 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
Adds a Developer Workflow section to
CONTRIBUTING.md. The existing guide covered community process (asking questions, reporting issues, DCO, TSC governance) but gave contributors no technical onboarding. This fills that gap.New content:
.devcontainer/workflow, default PG 16, forwarded ports (9712 Postgres, 10260 gateway)docs/build-from-source.mdmake install-documentdb, per-component targets,cargo build, and theDEBUG=yes/PG_VERSIONbuild flagscheck,check-minimal,check-extended-rum,check-isolation,check-valgrind), Rust gateway unit + integration tests, with a pointer topg_documentdb_gw/CONTRIBUTING.mdrun-functional-tests.shPR gate (allowlist / single / full)Existing community-process content is preserved verbatim. A Table of Contents was added for navigation.
Verification
Every command, make target, port, file path, and flag was checked against the repo tree (
.devcontainer/devcontainer.json, the component Makefiles,scripts/,documentdb_tests/tests/, andrun-functional-tests.sh).Note on cross-links
This doc links to
docs/build-from-source.md, which is delivered by a sibling docs PR (branchdocs/build-from-source). Merge that PR first, or merge together, so the link resolves.Checklist