Skip to content

Commit

Permalink
docs: update contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
JeanNeiverth committed Oct 28, 2024
1 parent eb4ccd1 commit 13936b9
Showing 1 changed file with 35 additions and 7 deletions.
42 changes: 35 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,43 @@ pnpm check
pnpm build
```

## 🤝 Contributing
## 🛠 Creating Your Own Hook dApp

We welcome contributions! Please feel free to submit pull requests or open issues for any improvements or bug fixes.
Want to create your own hook? Follow these steps to add a new hook dApp to the monorepo:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
1. Create a new project in the apps directory:

```bash
bashCopycd apps
mkdir my-custom-hook
cd my-custom-hook
```

2. Copy the basic package.json structure from one of the existing apps, making sure to update:

```json
{
"name": "@cow-hooks-dapps/my-custom-hook",
"description": "Your hook description",
"version": "0.1.0"
// ... rest of the configuration
}
```

3. Feel free to reuse any components from the packages workspace - that's what it's there for! The shared components can save you time and ensure consistency across hooks.
4. Implement your hook logic following the existing patterns in other apps (remember providing a manifest.json in the app public folder with the hook informations).
5. Deploy your hook:

- You can deploy to any platform of your choice (Vercel, Netlify, AWS, etc.)
- Make sure your deployment URL is HTTPS-enabled
- Test your deployed hook by adding it to CoW Swap using the deployed URL

Remember to:

- Keep your hook focused on a single, clear purpose
- Maintain good error handling and user feedback
- Test thoroughly with different token combinations
- Document any special requirements or configurations

## 📚 Documentation

Expand Down

0 comments on commit 13936b9

Please sign in to comment.