mirror of
https://github.com/zhayujie/chatgpt-on-wechat.git
synced 2026-06-02 00:57:41 +08:00
62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
# Contributing to CowAgent
|
||
|
||
Thanks for taking the time to contribute! 🎉 CowAgent is built by a global
|
||
community, and contributions of all sizes are welcome — from typo fixes to new
|
||
features.
|
||
|
||
## Language policy
|
||
|
||
To keep the project accessible to a global community, **please write issues,
|
||
pull requests, code comments, and commit messages in English.**
|
||
|
||
> 为方便全球开发者协作，请尽量使用**英文**提交 issue、PR、代码注释与
|
||
> commit message。不必担心英文不完美——表达清楚即可，工具翻译也完全没问题。感谢理解 ❤️
|
||
|
||
## Reporting issues
|
||
|
||
Found a bug or have an idea? [Open an issue](https://github.com/zhayujie/CowAgent/issues/new/choose).
|
||
|
||
Before opening one, please search existing issues (including closed ones) to
|
||
avoid duplicates, and make sure you're on the latest version.
|
||
|
||
## Submitting a pull request
|
||
|
||
1. **Fork** the repo and create a branch from `master`
|
||
(e.g. `feat/web-search`, `fix/telegram-reconnect`).
|
||
2. Make your change. Keep it focused — one logical change per PR.
|
||
3. Follow the existing code style. Write comments and docstrings in English.
|
||
4. Run the app locally to confirm your change works.
|
||
5. Open a PR with a clear title and a short description of **what** and **why**.
|
||
|
||
We keep the bar friendly: clear, focused, and working is enough. Maintainers are
|
||
happy to help polish details during review.
|
||
|
||
### Commit & PR titles
|
||
|
||
Use a short, imperative summary. The [Conventional Commits](https://www.conventionalcommits.org/)
|
||
style is preferred but not required:
|
||
|
||
```
|
||
feat: add web search tool
|
||
fix: reconnect Telegram websocket on timeout
|
||
docs: clarify Docker setup
|
||
```
|
||
|
||
## Development setup
|
||
|
||
See the [Install from Source](https://docs.cowagent.ai/guide/manual-install)
|
||
guide. In short:
|
||
|
||
```bash
|
||
git clone https://github.com/zhayujie/CowAgent.git
|
||
cd CowAgent
|
||
pip install -r requirements.txt
|
||
pip install -e .
|
||
cow start
|
||
```
|
||
|
||
## Code of conduct
|
||
|
||
Be respectful and constructive. We want CowAgent to be a welcoming place for
|
||
everyone.
|