mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-06-12 19:55:19 +02:00
fix contribution
This commit is contained in:
Arjun
parent
6b2cd80932
commit
7204964779
2 changed files with 32 additions and 36 deletions
|
|
@ -1,59 +1,55 @@
|
|||
---
|
||||
title: "Contribution Guide"
|
||||
description: "Learn how to contribute to the Rowboat project and help improve our platform."
|
||||
description: "How to contribute to Rowboat — from bug reports to pull requests."
|
||||
icon: "github"
|
||||
---
|
||||
|
||||
# Join the Rowboat Voyage
|
||||
# Contributing to Rowboat
|
||||
|
||||
We're building Rowboat as an open-source, community-powered platform — and we'd love for you to hop aboard! Whether you're fixing typos, suggesting a new tool integration, or designing your dream multi-agent workflow, your contributions are valuable and welcome.
|
||||
Rowboat is open-source and we welcome contributions of all kinds — bug reports, feature ideas, code, and docs improvements.
|
||||
|
||||
<Frame>
|
||||
<img src="/docs/img/contribution-guide-hero.png" className="w-full max-w-[600px] rounded-xl" alt="Contribution guide hero image showing community collaboration" />
|
||||
</Frame>
|
||||
**Quick links:**
|
||||
- [GitHub Repository](https://github.com/rowboatlabs/rowboat)
|
||||
- [Discord Community](https://discord.gg/wajrgmJQ6b)
|
||||
- [Open Issues](https://github.com/rowboatlabs/rowboat/issues)
|
||||
|
||||
---
|
||||
|
||||
## How You Can Contribute
|
||||
## Ways to Contribute
|
||||
|
||||
**Report bugs or suggest improvements** — If something feels off or could be better, [open an issue](https://github.com/rowboatlabs/rowboat/issues/new). Include steps to reproduce for bugs, or a clear description of the improvement you have in mind.
|
||||
|
||||
- **Tackle Open Issues**
|
||||
Browse our [GitHub Issues](https://github.com/rowboatlabs/rowboat/issues) for tags like `good first issue`, `help wanted`, or `bug` to find a spot that fits your skillset.
|
||||
**Fix an existing issue** — Browse [open issues](https://github.com/rowboatlabs/rowboat/issues) and comment on one to let us know you're working on it.
|
||||
|
||||
- **Join the Community**
|
||||
Our [Discord](https://discord.gg/rxB8pzHxaS) is the go-to hub for brainstorming, feedback, and finding contributors for bigger efforts.
|
||||
|
||||
- **Propose Something New**
|
||||
Have a new tool integration idea or found a bug? Open an issue and let’s discuss it!
|
||||
**Propose a new feature or integration** — Open an issue first so we can discuss the approach before you invest time building it.
|
||||
|
||||
**Improve documentation** — Typos, unclear explanations, missing examples — all fair game.
|
||||
|
||||
---
|
||||
|
||||
## Contribution Workflow & Best Practices
|
||||
|
||||
Whether it's your first contribution or your fiftieth, here's what a great contribution looks like:
|
||||
|
||||
| Step / Tip | Description |
|
||||
|-------------------------------|-----------------------------------------------------------------------------------------------|
|
||||
| **1. Fork the Repository** | Create a personal copy of [rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat) to start contributing. |
|
||||
| **2. Create a New Branch** | Use a descriptive name like `fix-tool-crash` or `feature-new-mcp`. Avoid committing to `main`. |
|
||||
| **3. Make Your Changes** | Focus your PR on a single issue or feature to keep things clean and reviewable. |
|
||||
| **4. Write Tests if Needed** | If you change logic, add relevant tests so your contribution is future-proof. |
|
||||
| **5. Run Tests & Lint Locally**| Make sure your branch passes all tests and code quality checks before pushing. |
|
||||
| **6. Document or Demo It** | Add helpful context: screenshots, example scripts, or a short video/gif to demonstrate your changes. |
|
||||
| **7. Submit a Pull Request** | Open a PR with a clear description of your changes and any context reviewers should know. |
|
||||
| **8. Collaborate on Feedback** | Our maintainers may leave comments — it’s all part of the process. Let’s improve it together. |
|
||||
| **9. Don’t Be Shy to Follow Up** | Feel free to ping the PR/issue if you're waiting on feedback. We appreciate polite nudges. |
|
||||
| **10. Celebrate the Merge!** | You just made Rowboat better. Thanks for contributing 🚀 |
|
||||
|
||||
<Tip>If you're fixing typos, spacing, or small tweaks — try bundling those into a related PR instead of sending them standalone. It helps keep reviews focused. </Tip>
|
||||
## Contribution Workflow
|
||||
|
||||
1. **Fork** [rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat) and clone it locally.
|
||||
2. **Create a branch** with a descriptive name (`fix-tool-crash`, `feature-mcp-discovery`). Don't commit directly to `main`.
|
||||
3. **Make your changes.** Keep PRs focused on a single issue or feature.
|
||||
4. **Test your changes** locally before submitting.
|
||||
5. **Open a pull request** with a clear description of what you changed and why. Screenshots or short demos are appreciated for UI changes.
|
||||
6. **Respond to feedback** — maintainers may request changes. This is normal and collaborative.
|
||||
7. **Merge!** Once approved, we'll merge your PR.
|
||||
|
||||
<Tip>For small fixes like typos or formatting, try bundling related changes into a single PR rather than submitting them individually.</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Come Build With Us
|
||||
## Guidelines
|
||||
|
||||
We believe great ideas come from the community — and that means **you**. Whether you're an engineer, designer, AI tinkerer, or curious beginner, there’s room on this boat for everyone.
|
||||
- **One PR, one concern.** Don't mix unrelated changes in the same pull request.
|
||||
- **Write clear commit messages.** A reviewer should understand what changed from the message alone.
|
||||
- **Follow existing code style.** Match the patterns you see in the codebase.
|
||||
- **Be patient and respectful.** We review PRs as quickly as we can. A polite ping on Discord is always welcome if things go quiet.
|
||||
|
||||
Let’s build the future of AI workflows — together. 🫶
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you're stuck or unsure about anything, drop a message in our [Discord](https://discord.gg/wajrgmJQ6b). We're happy to help you get unblocked.
|
||||
|
|
@ -108,7 +108,7 @@ Need help using Rowboat? Join our community!
|
|||
<Card
|
||||
title="Discord"
|
||||
icon="discord"
|
||||
horizontal href="https://discord.gg/rxB8pzHxaS"
|
||||
horizontal href="https://discord.gg/wajrgmJQ6b"
|
||||
>
|
||||
Join our growing discord community and interact with hundreds of developer using Rowboat!
|
||||
</Card>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue