Repository navigation
docs: add repository and design guidelines - #1678
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 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
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.

Proposed Changes
AGENTS.mdwith repository structure, development commands, coding conventions, testing guidance, and commit/PR expectations.DESIGN.mdfollowing the design.md alpha specification, documenting React Bootstrap as the design foundation and the default primary color#0033FF.Validation
DESIGN.mdcontains no Chinese text.git diff --cached --checkpassed before committing.