Skip to content

docs: clarify coding and development guidelines - #531

Open
zjw1111 wants to merge 1 commit into
apache:mainfrom
zjw1111:codex/code-style-guidelines
Open

zjw1111 wants to merge 1 commit into
apache:mainfrom
zjw1111:codex/code-style-guidelines

Conversation

@zjw1111

@zjw1111 zjw1111 commented Nov 6, 2026

Copy link
Copy Markdown
Collaborator

Purpose

Linked issue: N/A (documentation-only change).

Coding conventions and contribution workflow are currently mixed in the code style guide, while several design and testing expectations are implicit. This change gives each topic a primary home:

  • Clarify parameter ordering, output and input/output pointers, ownership, initialization, comments, and test macros in the code style guide.
  • Add development guidelines for defaults, abstraction, dependencies, return semantics, validation boundaries, and effective regression coverage. Keep defensive checks, overflow tests, and mock interaction assertions proportionate to reachable risks and required behavior.
  • Consolidate setup, validation commands, and the PR checklist in CONTRIBUTING.md, document external code attribution, and update the shared guidance links in AGENTS.md.

Tests

No tests are added or modified because this change only updates contributor documentation and does not change runtime behavior.

API and Format

No changes to public APIs, storage formats, or protocols.

Documentation

Updates CONTRIBUTING.md, docs/code-style.md, and AGENTS.md; adds docs/development-guidelines.md.

Generative AI tooling

Generated-by: Codex CLI 0.163.0

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant