Files
page-agent/CONTRIBUTING.md
T

48 lines
1.6 KiB
Markdown
Raw Normal View History

2026-03-09 17:00:25 +08:00
# Contributing to PageAgent
2025-09-29 16:33:15 +08:00
♥️ We welcome contributions from everyone.
2025-09-29 16:33:15 +08:00
For local development workflows, setup, local LLM config, extension development, testing on other websites, and more details, see [docs/developer-guide.md](docs/developer-guide.md).
2025-09-29 16:33:15 +08:00
## 🤝 How to Contribute
> **[Maintainer's Note](https://github.com/alibaba/page-agent/issues/349)**
### Opening Issues
2025-09-29 16:33:15 +08:00
- Use the GitHub issue tracker to report bugs or request features
- Search existing issues before creating new ones
- Provide clear reproduction steps for bugs
- Include browser version and environment details
### Code Contributions
1. Follow existing code style and patterns
2. Update documentation as needed
3. Add JSDoc for public APIs
4. Build and lint everything
5. Test in our demo website, and on other websites if applicable
6. Include screenshots for UI changes
2025-09-29 16:58:07 +08:00
2026-03-09 17:00:25 +08:00
### Vibe Coding with AI
- Vibe coding is **NOT** allowed for the core lib or the extension!!!
2026-03-09 17:00:25 +08:00
- Vibe coding is **RECOMMENDED** when maintaining **the demo, the website, the UI and tests**.
- Make sure your AI references `AGENTS.md` and `website/AGENTS.md` for better quality.
2025-09-29 16:58:07 +08:00
- Review anything AI wrote before make a commit. You are the author of anything you commit. NOT AI.
2025-09-29 16:33:15 +08:00
## 🚫 What We Don't Accept
2026-03-09 17:00:25 +08:00
- Breaking changes and large PRs without prior discussion
- Heavy dependencies to core libs
- Dependencies or code with licenses incompatible with MIT
2026-03-10 22:06:41 +08:00
- Bot or AI-generated pull requests without meaningful human involvement
2025-09-29 16:33:15 +08:00
## 📄 Legal
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
---
2025-09-29 16:33:15 +08:00
2026-03-09 17:00:25 +08:00
Thank you for helping make PageAgent better! 🎉