Skip to content

docs: align shared development guidance with each repository's language and CI tools #76

Closed

Description

@yeongseon

Problem

The organization CONTRIBUTING.md currently presents a single ESLint + Prettier TypeScript style and only describes Python, TypeScript and Go. The active organization also contains Rust, C/C++/Java, Kubernetes Operator, Terraform, benchmarking and generated-asset/docs repositories. Actual project toolchains differ: some TS packages have Biome configuration while their npm scripts either invoke ESLint or do not expose lint/format commands.

This issue is about accurate, discoverable shared guidance only, not a universal formatter, a common runtime, synchronized releases, or a cross-repository implementation gate. A repository's manifest, its own contributor documentation and verified CI remain authoritative.

Snapshot: language-development policy review, 2026-11-07

All 18 currently installed cubrid-lab repositories were reviewed at the policy/configuration level (root contributor guidance, project manifests, available source/config/CI). This is a static configuration review, not evidence all tests or support matrices passed.

Repository Language/scope Outcome / local issue
pycubrid Python Detailed Ruff/Mypy/pytest and protocol/live validation; no new verified policy mismatch
sqlalchemy-cubrid Python Detailed Ruff/Mypy/pytest and dialect/driver version policy; separate CI path selection #1154
cubrid-mcp-server Python Detailed tooling/coverage/stdio/live test contract; no new verified policy mismatch
cubrid-cookbook-python Python recipes Detailed golden examples, support and optional DB lanes; no new verified policy mismatch
cubrid-client TypeScript/Node Documentation says Biome but package has no lint/format scripts and CI does not execute it: #217
drizzle-cubrid TypeScript/Node Biome docs/config vs ESLint npm scripts, CI coverage gate without separate lint: #167; verified coverage issue #154
cubrid-go Go driver Go 1.21 baseline and module semantics documented; old cubrid-labs module and support links need deliberate canonical-path treatment in existing #57
gorm-cubrid Go GORM adapter Main CI integration job does not prove live behavior without integration-tagged tests: #43; version policy #40
cubrid-rs Rust driver Cargo MSRV 1.75, current CI minimum lane 1.85: #33
sea-orm-cubrid Rust SeaORM adapter Cargo 1.88 vs Clippy/roadmap 1.75, CI stable only: #26; adapter policy #23
cubrid-benchmark Python + optional TS/Go/Rust Toolchain quality checks not defined consistently, TS research track lacks linter: #72
cubrid-kubernetes-operator Go/Kubernetes Strong ADR, Go toolchain, generated-code and E2E policy; no new verified policy mismatch
terraform-zadara-k8s Terraform/IaC Root contribution guide lacks standalone safe plan/state/toolchain workflow: #72
cubrid C/C++ and Java Language/build/test instructions scattered across AGENTS files and CMake/Gradle; GitHub Issues disabled (HTTP 410), so do not represent an issue as filed. Report separately via a repo-supported maintainer channel
showcase Node/HTML/presentations Narrow scope, existing artifact validation and publishing guidance; no new verified policy mismatch
cubrid-lab.github.io Python/MkDocs site Existing build/deploy guidance fits site scope; no new verified policy mismatch
brand Python asset generator Explicit deterministic generation and legal/approval rules; no new verified policy mismatch
.github Organization documentation Shared language tool/coverage examples too prescriptive/incomplete; this issue

Scope and acceptance

  • Rewrite organization guidance as language-idiomatic examples, not mandatory global tooling. Explicitly show Python/Ruff+Mypy, TypeScript/ESLint or Biome as locally chosen, Go/gofmt+vet, Rust/rustfmt+Clippy, C/C++/CMake+native tests, Java/build-tool-specific tests, and Terraform/fmt+validate+approved plan.
  • State authoritative source hierarchy: repository CONTRIBUTING + actual manifest + CI commands and release policy override generic org examples when specific.
  • Distinguish minimum declared runtime versions from versions actually exercised in CI, and offline tests from real CUBRID integration evidence.
  • Keep specialized repositories (docs sites, assets, benchmarks, Operator, engine) aligned with their actual scope; do not impose a uniform Python/Node/Go stack.
  • Add links to each repository's actual development policy and document gaps without creating unnecessary duplicated issues.
  • Do not create a new bot, mandatory cross-repository CI gate, synchronized release workflow, or required organization approval.
  • Link to conceptual language-native connector principles #73 for background only; docs: document language-idiomatic principles for independent connectors #73 explicitly is not a tracking issue and must remain independent.

Completion evidence

A maintainer-reviewed docs PR which updates the organization's concrete development examples, cross-checks them against repo manifests, and leaves all existing runtime CI and releases untouched. Repository-specific corrections are independently triaged and verified in the owning repository.

Activity

  1. yeongseon commented on Nov 7, 2026

    @yeongseon
    ContributorAuthor

    Confirmed issue filings and duplicate handling (2026-11-07)

    Repository-owned new issues (all opened with status: needs triage):

    Existing issues updated instead of duplicates: cubrid-client #96, drizzle-cubrid #151 and #154, cubrid-go #57, gorm-cubrid #40, and sea-orm-cubrid #23.

    Blocked: cubrid has repository GitHub Issues disabled (API 410). No local issue was created. The potential contributor-facing C++/Java validation index remains a recorded audit observation, not an assigned task.

    Repositories without a verified mismatch were not given artificial issues. Each local issue is independently actionable and not gated on the organization docs issue. Nothing was merged or released as part of this audit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions