diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2a83bc2 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,19 @@ +# Code of Conduct + +This project welcomes participation from everyone. + +## Expected behavior + +- Be respectful and constructive. +- Focus on the work, not the person. +- Give and receive feedback in good faith. + +## Unacceptable behavior + +- Harassment or discrimination +- Threats, insults, or personal attacks +- Deliberate disruption of discussion or collaboration + +## Enforcement + +Maintainers may remove content or decline contributions that violate this code of conduct. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..aa08dce --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +Thanks for helping improve `go-claude`. + +## Before you start + +- Read the README and the existing `AGENTS.md` notes in the repository. +- Open an issue or discussion for larger changes before starting work. + +## Local development + +```bash +go test ./... +go build ./cmd/agent-cli +``` + +## Pull request checklist + +- Keep changes focused. +- Run `go test ./...` before opening a PR. +- Include context for user-facing changes. +- Update documentation when behavior changes. + +## Reporting bugs + +Please include: + +- the command you ran +- the expected result +- the actual result +- relevant logs or screenshots diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..47ded16 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy + +## Reporting a vulnerability + +Please report security issues privately through GitHub Security Advisories for this repository. + +Do not disclose sensitive details in public issues or pull requests. + +## What to include + +- A short summary of the issue +- Steps to reproduce +- Affected versions +- Any proof-of-concept material, if available diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..e6af06a --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,9 @@ +# Support + +For help using `go-claude`: + +- Read the README for setup and usage. +- Open a GitHub issue for bugs or missing behavior. +- Use GitHub Discussions for questions, ideas, or community support. + +When reporting a problem, include your OS, Go version, command, and the output you saw. diff --git a/README.md b/README.md index aee5241..62c9628 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,13 @@ pkg/llm pkg/tui pkg/config 是否授权执行此操作? (y/n/a) ``` +## Community + +- [Contributing Guide](.github/CONTRIBUTING.md) +- [Code of Conduct](.github/CODE_OF_CONDUCT.md) +- [Security Policy](.github/SECURITY.md) +- [Support](.github/SUPPORT.md) + ## License [Apache-2.0](LICENSE) diff --git a/README_CN.md b/README_CN.md index ca65821..c870c6e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -117,6 +117,13 @@ pkg/llm pkg/tui pkg/config 是否授权执行此操作? (y/n/a) ``` +## 社区 + +- [贡献指南](.github/CONTRIBUTING.md) +- [行为准则](.github/CODE_OF_CONDUCT.md) +- [安全策略](.github/SECURITY.md) +- [支持](.github/SUPPORT.md) + ## 许可证 [Apache-2.0](LICENSE)