181 lines
4.9 KiB
Markdown
181 lines
4.9 KiB
Markdown
# Contributing to Page-Agent
|
|
|
|
Thank you for your interest in contributing to Page-Agent! We welcome contributions from everyone.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Development Setup
|
|
|
|
1. **Prerequisites**
|
|
- Node.js 20+
|
|
- npm 10+
|
|
- typescript as required in package.json
|
|
- vscode or other editors that support ts/eslint/prettier
|
|
- make sure `eslint`, `auto-format` and `commit-lint` all work
|
|
|
|
2. **Setup**
|
|
|
|
```bash
|
|
npm install
|
|
npm start # Start demo and documentation site
|
|
```
|
|
|
|
### Project Structure
|
|
|
|
This is a **monorepo** with npm workspaces containing **two main packages**:
|
|
|
|
1. **Core Library** (`packages/page-agent/`) - Pure JavaScript/TypeScript AI agent library for browser DOM automation, published as `page-agent` on npm
|
|
2. **Website** (`packages/website/`) - React documentation and landing page. Also as demo and test page for the core lib. private package `@page-agent/website`
|
|
|
|
We use a simplified monorepo solution with native npm-workspace. No fancy tooling. Hoisting is required.
|
|
|
|
## 🤝 How to Contribute
|
|
|
|
### Reporting Issues
|
|
|
|
- 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. **Fork and Clone**
|
|
|
|
```bash
|
|
git clone https://github.com/your-username/page-agent.git
|
|
cd page-agent
|
|
```
|
|
|
|
2. **Create Feature Branch**
|
|
|
|
```bash
|
|
git checkout -b feat/your-feature-name
|
|
```
|
|
|
|
3. **Make Changes**
|
|
- Follow existing code style and patterns
|
|
- Add tests for new functionality
|
|
- Update documentation as needed
|
|
|
|
4. **Test Your Changes**
|
|
|
|
```bash
|
|
# TODO
|
|
```
|
|
|
|
5. **Commit and Push**
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "feat: add awesome feature"
|
|
git push origin feat/your-feature-name
|
|
```
|
|
|
|
6. **Create Pull Request**
|
|
- Provide clear description of changes
|
|
- Link related issues
|
|
- Include screenshots for UI changes
|
|
|
|
## 📝 Code Style
|
|
|
|
### General Guidelines
|
|
|
|
- Use TypeScript for type safety
|
|
- Follow existing naming conventions
|
|
- Write meaningful commit messages
|
|
- Keep functions small and focused
|
|
- Add JSDoc for public APIs
|
|
|
|
### Vibe coding with AI
|
|
|
|
- It's **recommended** to heavily rely on AI (aka "vibe coding") when maintaining **demo pages and tests**.
|
|
- BUT **NOT the core lib!!!** Be very careful if AI ever touched the core lib!!!
|
|
- Review anything AI wrote before make a commit. You are the author of anything you commit. NOT AI.
|
|
- Update the AI instructions when structure changed.
|
|
- Cursor and Cline: `./.cursor/rules`
|
|
- Github Copilot: `./.github/copilot-instructions.md`
|
|
- Claude Code: `./CLAUDE.md`
|
|
|
|
### Core Library (`src/`)
|
|
|
|
- **No React dependencies** - Pure JavaScript/TypeScript only
|
|
- Use event bus for component communication
|
|
- Follow browser-use patterns for DOM operations
|
|
|
|
### Doc&demo Site (`pages/`)
|
|
|
|
- Use React 19 + TypeScript
|
|
- Follow hash routing patterns (`useHashLocation`)
|
|
- Use Tailwind CSS for styling
|
|
- Add new docs pages to both router and sidebar
|
|
|
|
## 🔧 Development Workflows
|
|
|
|
### Website Development
|
|
|
|
```bash
|
|
npm start # React development server
|
|
```
|
|
|
|
### Core Lib Development and Testing
|
|
|
|
- Config your LLM API
|
|
- Start a local script
|
|
|
|
```bash
|
|
npm run build:lib:watch # Auto-rebuild on changes
|
|
```
|
|
|
|
- Add a new bookmark enable it on other website
|
|
|
|
```
|
|
javascript:(function(){var s=document.createElement('script');s.src=`http://localhost:5173/dist/lib/page-agent.umd.cjs?t=${Math.random()}`;s.onload=()=>console.log(%27PageAgent ready!%27);document.head.appendChild(s);})();
|
|
```
|
|
|
|
### Adding Documentation
|
|
|
|
1. Create `pages/docs/section/page-name/page.tsx`
|
|
2. Add route to `pages/router.tsx`
|
|
3. Add navigation link to `pages/components/DocsLayout.tsx`
|
|
|
|
## 🎯 Contribution Areas
|
|
|
|
We especially welcome contributions in:
|
|
|
|
- **Browser compatibility** improvements
|
|
- **Performance optimizations** for DOM processing
|
|
- **Documentation** and examples
|
|
- **Testing** and quality assurance
|
|
- **Accessibility** features
|
|
- **Internationalization** support
|
|
|
|
## 🚫 What We Don't Accept
|
|
|
|
- Changes that break existing API compatibility
|
|
- Heavy dependencies to core library
|
|
- Contributions without proper testing
|
|
- Code that doesn't follow project conventions
|
|
|
|
## 📄 Legal
|
|
|
|
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
|
|
|
|
> You may need to sign a github CLA before you create a PR.
|
|
|
|
### Browser-Use Attribution
|
|
|
|
Parts of this project are derived from the [browser-use](https://github.com/browser-use/browser-use) project (MIT License). When contributing to DOM-related functionality:
|
|
|
|
- Maintain existing attribution comments
|
|
- Follow similar patterns for consistency
|
|
- Credit browser-use for derived concepts
|
|
|
|
## 💬 Questions?
|
|
|
|
- Open a GitHub issue for technical questions
|
|
- Check existing documentation and issues first
|
|
- Be respectful and constructive in discussions
|
|
|
|
Thank you for helping make Page-Agent better! 🎉
|