Skip to content

docs: add repository and design guidelines - #1678

Merged
fenbox merged 2 commits into
apache:mainfrom
fenbox:docs/repository-design-guidelines
Nov 19, 2026
Merged

fenbox merged 2 commits into
apache:mainfrom
fenbox:docs/repository-design-guidelines

Conversation

@fenbox

@fenbox fenbox commented Nov 19, 2026

Copy link
Copy Markdown
Member

Proposed Changes

  • Add AGENTS.md with repository structure, development commands, coding conventions, testing guidance, and commit/PR expectations.
  • Add an English DESIGN.md following the design.md alpha specification, documenting React Bootstrap as the design foundation and the default primary color #0033FF.
  • Document existing theme overrides, dark mode, layout conventions, and component usage, with YAML design tokens and source references.

Validation

  • Checked commands and conventions against repository configuration and source files.
  • Confirmed DESIGN.md contains no Chinese text.
  • git diff --cached --check passed before committing.
  • Documentation-only changes; no application tests run.

Copilot AI balanced review requested due to automatic review settings November 19, 2026 06:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The setup instructions omit the local API proxy configuration and Docker or Podman prerequisite, causing UI requests to target a private address and blocking linting for developers with only the listed dependencies.

2 open issues
What changed in this PR

This documentation-only PR adds contributor guidance and a design reference for Apache Answer’s Go backend and React/TypeScript frontend.

Changes:

  • Documents repository structure, development commands, coding conventions, testing, and PR expectations.
  • Defines React Bootstrap as the design foundation, with default primary color #0033FF.
  • Describes theme overrides, dark mode, responsive layouts, and component usage with design tokens and source references.
File Description
DESIGN.md Adds design principles, theme guidance, component conventions, and YAML tokens.
AGENTS.md Adds repository organization and contributor workflow guidance.

Review effort: Balanced

Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
@fenbox
fenbox merged commit 9e6ca4a into apache:main Nov 19, 2026
2 checks passed
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.

2 participants