Skip to content

docs: add contributing guide - #615

Open
Usernames686 wants to merge 1 commit into
xintaofei:mainfrom
Usernames686:codex/docs-contributing-guide
Open

docs: add contributing guide#615
Usernames686 wants to merge 1 commit into
xintaofei:mainfrom
Usernames686:codex/docs-contributing-guide

Conversation

@Usernames686

@Usernames686 Usernames686 commented Aug 31, 2026

Copy link
Copy Markdown

Summary

Adds a lightweight contribution guide for Codeg and links it from the README.

Fixes #571.

What changed

  • added CONTRIBUTING.md
  • documented bug reports and feature requests
  • documented PR scope, title style, and review expectations
  • documented repository-specific frontend, desktop, server, and MCP checks
  • documented UI, cross-platform, documentation, and security-reporting considerations
  • added a README link to the contribution guide

Validation

  • pnpm lint
  • pnpm exec prettier --check CONTRIBUTING.md README.md
  • verified local and external Markdown links
  • verified the documented Cargo targets against src-tauri/Cargo.toml and Cargo metadata
  • cargo check --no-default-features --bin codeg-mcp
  • cargo test --no-default-features --lib acp::delegation (234 passed)
  • cargo clippy --no-default-features --bin codeg-mcp -- -D warnings
  • git diff --check

Notes

The guide intentionally stays lightweight and reflects the current repository commands and workflows. Issue/PR templates and additional contribution automation are left for separate follow-up changes.

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.

[Docs] 建议新增 CONTRIBUTING.md,统一社区 Issue 和 PR 提交规范

1 participant