51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# Contributing to AutoClaw 🦞
|
|
|
|
Thank you for your interest in contributing to AutoClaw! We welcome contributions from everyone.
|
|
|
|
## Getting Started
|
|
|
|
1. **Fork the repository**: Click the "Fork" button on GitHub.
|
|
2. **Clone your fork**:
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/autoclaw.git
|
|
cd autoclaw
|
|
```
|
|
3. **Install dependencies**:
|
|
```bash
|
|
npm install
|
|
```
|
|
4. **Create a branch**:
|
|
```bash
|
|
git checkout -b feature/my-new-feature
|
|
```
|
|
|
|
## Development Guidelines
|
|
|
|
- **Code Style**: We use TypeScript. Please follow the existing code style (formatting, variable naming).
|
|
- **Testing**: Before submitting a PR, please run `npm run build` to ensure there are no compilation errors.
|
|
- **Commit Messages**: Write clear, descriptive commit messages. We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification (e.g., `feat: add new tool`, `fix: correct typo in README`).
|
|
|
|
## Submitting a Pull Request
|
|
|
|
1. Push your changes to your fork:
|
|
```bash
|
|
git push origin feature/my-new-feature
|
|
```
|
|
2. Go to the [original repository](https://github.com/tsingliuwin/autoclaw) and click "New Pull Request".
|
|
3. Describe your changes clearly. What problem does it solve? Why is this change necessary?
|
|
4. Wait for review! We will review your PR as soon as possible.
|
|
|
|
## Reporting Bugs
|
|
|
|
If you find a bug, please open an issue on GitHub with:
|
|
- A clear description of the bug.
|
|
- Steps to reproduce.
|
|
- Expected behavior.
|
|
- Screenshots or logs if applicable.
|
|
|
|
## Feature Requests
|
|
|
|
Have an idea for a new feature? Open an issue with the "enhancement" label and let's discuss it!
|
|
|
|
---
|
|
Thank you for helping make AutoClaw better!
|