Skip to content

Commit 2749943

Browse files
committed
Updating instructions for contributing
1 parent 687d880 commit 2749943

File tree

2 files changed

+45
-40
lines changed

2 files changed

+45
-40
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,63 @@
1-
# Contributing to Cline
1+
# Contributing to Roo Code
22

3-
We're thrilled you're interested in contributing to Cline. Whether you're fixing a bug, adding a feature, or improving our docs, every contribution makes Cline smarter! To keep our community vibrant and welcoming, all members must adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
3+
We're thrilled you're interested in contributing to Roo Code. Whether you're fixing a bug, adding a feature, or improving our docs, every contribution makes Roo Code smarter! To keep our community vibrant and welcoming, all members must adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
44

55
## Reporting Bugs or Issues
66

7-
Bug reports help make Cline better for everyone! Before creating a new issue, please [search existing ones](https://github.com/cline/cline/issues) to avoid duplicates. When you're ready to report a bug, head over to our [issues page](https://github.com/cline/cline/issues/new/choose) where you'll find a template to help you with filling out the relevant information.
7+
Bug reports help make Roo Code better for everyone! Before creating a new issue, please [search existing ones](https://github.com/RooVetGit/Roo-Code/issues) to avoid duplicates. When you're ready to report a bug, head over to our [issues page](https://github.com/RooVetGit/Roo-Code/issues/new/choose) where you'll find a template to help you with filling out the relevant information.
88

99
<blockquote class='warning-note'>
10-
🔐 <b>Important:</b> If you discover a security vulnerability, please use the <a href="https://github.com/cline/cline/security/advisories/new">Github security tool to report it privately</a>.
10+
🔐 <b>Important:</b> If you discover a security vulnerability, please use the <a href="https://github.com/RooVetGit/Roo-Code/security/advisories/new">Github security tool to report it privately</a>.
1111
</blockquote>
1212

1313
## Deciding What to Work On
1414

15-
Looking for a good first contribution? Check out issues labeled ["good first issue"](https://github.com/cline/cline/labels/good%20first%20issue) or ["help wanted"](https://github.com/cline/cline/labels/help%20wanted). These are specifically curated for new contributors and areas where we'd love some help!
15+
Looking for a good first contribution? Check out issues in the "Issue [Unassigned]" section of our [Roo Code Issues](https://github.com/orgs/RooVetGit/projects/1) Github Project. These are specifically curated for new contributors and areas where we'd love some help!
1616

17-
We also welcome contributions to our [documentation](https://github.com/cline/cline/tree/main/docs)! Whether it's fixing typos, improving existing guides, or creating new educational content - we'd love to build a community-driven repository of resources that helps everyone get the most out of Cline. You can start by diving into `/docs` and looking for areas that need improvement.
17+
We also welcome contributions to our [documentation](https://docs.roocode.com/)! Whether it's fixing typos, improving existing guides, or creating new educational content - we'd love to build a community-driven repository of resources that helps everyone get the most out of Roo Code. You can click "Edit this page" on any page to quickly get to the right spot in Github to edit the file, or you can dive directly into https://github.com/RooVetGit/Roo-Code-Docs.
1818

19-
If you're planning to work on a bigger feature, please create a [feature request](https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) first so we can discuss whether it aligns with Cline's vision.
19+
If you're planning to work on a bigger feature, please create a [feature request](https://github.com/RooVetGit/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) first so we can discuss whether it aligns with Roo Code's vision.
2020

2121
## Development Setup
2222

23-
1. **VS Code Extensions**
23+
1. **Clone** the repo:
2424

25-
- When opening the project, VS Code will prompt you to install recommended extensions
26-
- These extensions are required for development - please accept all installation prompts
27-
- If you dismissed the prompts, you can install them manually from the Extensions panel
25+
```sh
26+
git clone https://github.com/RooVetGit/Roo-Code.git
27+
```
2828

29-
2. **Local Development**
30-
- Run `npm run install:all` to install dependencies
31-
- Run `npm run test` to run tests locally
32-
- Before submitting PR, run `npm run format:fix` to format your code
29+
2. **Install dependencies**:
30+
31+
```sh
32+
npm run install:all
33+
```
34+
35+
3. **Start the webview (Vite/React app with HMR)**:
36+
37+
```sh
38+
npm run dev
39+
```
40+
41+
4. **Debug**:
42+
Press `F5` (or **Run****Start Debugging**) in VSCode to open a new session with Roo Code loaded.
43+
44+
Changes to the webview will appear immediately. Changes to the core extension will require a restart of the extension host.
45+
46+
Alternatively you can build a .vsix and install it directly in VSCode:
47+
48+
```sh
49+
npm run build
50+
```
51+
52+
A `.vsix` file will appear in the `bin/` directory which can be installed with:
53+
54+
```sh
55+
code --install-extension bin/roo-cline-<version>.vsix
56+
```
3357

3458
## Writing and Submitting Code
3559

36-
Anyone can contribute code to Cline, but we ask that you follow these guidelines to ensure your contributions can be smoothly integrated:
60+
Anyone can contribute code to Roo Code, but we ask that you follow these guidelines to ensure your contributions can be smoothly integrated:
3761

3862
1. **Keep Pull Requests Focused**
3963

@@ -43,10 +67,9 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines
4367

4468
2. **Code Quality**
4569

46-
- Run `npm run lint` to check code style
47-
- Run `npm run format` to automatically format code
4870
- All PRs must pass CI checks which include both linting and formatting
4971
- Address any ESLint warnings or errors before submitting
72+
- Respond to all feedback from Ellipsis, our automated code review tool
5073
- Follow TypeScript best practices and maintain type safety
5174

5275
3. **Testing**
@@ -56,30 +79,19 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines
5679
- Update existing tests if your changes affect them
5780
- Include both unit tests and integration tests where appropriate
5881

59-
4. **Version Management with Changesets**
60-
61-
- Create a changeset for any user-facing changes using `npm run changeset`
62-
- Choose the appropriate version bump:
63-
- `major` for breaking changes (1.0.0 → 2.0.0)
64-
- `minor` for new features (1.0.0 → 1.1.0)
65-
- `patch` for bug fixes (1.0.0 → 1.0.1)
66-
- Write clear, descriptive changeset messages that explain the impact
67-
- Documentation-only changes don't require changesets
68-
69-
5. **Commit Guidelines**
82+
4. **Commit Guidelines**
7083

7184
- Write clear, descriptive commit messages
72-
- Use conventional commit format (e.g., "feat:", "fix:", "docs:")
7385
- Reference relevant issues in commits using #issue-number
7486

75-
6. **Before Submitting**
87+
5. **Before Submitting**
7688

7789
- Rebase your branch on the latest main
7890
- Ensure your branch builds successfully
7991
- Double-check all tests are passing
8092
- Review your changes for any debugging code or console logs
8193

82-
7. **Pull Request Description**
94+
6. **Pull Request Description**
8395
- Clearly describe what your changes do
8496
- Include steps to test the changes
8597
- List any breaking changes
@@ -88,5 +100,3 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines
88100
## Contribution Agreement
89101

90102
By submitting a pull request, you agree that your contributions will be licensed under the same license as the project ([Apache 2.0](LICENSE)).
91-
92-
Remember: Contributing to Cline isn't just about writing code - it's about being part of a community that's shaping the future of AI-assisted development. Let's build something amazing together! 🚀

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,7 @@ We use [changesets](https://github.com/changesets/changesets) for versioning and
161161

162162
## Contributing
163163

164-
We love community contributions! Here’s how to get involved:
165-
166-
1. **Check Issues & Requests**: See [open issues](https://github.com/RooVetGit/Roo-Code/issues) or [feature requests](https://github.com/RooVetGit/Roo-Code/discussions/categories/feature-requests).
167-
2. **Fork & branch** off `main`.
168-
3. **Submit a Pull Request** once your feature or fix is ready.
169-
4. **Join** our [Reddit community](https://www.reddit.com/r/RooCode/) and [Discord](https://roocode.com/discord) for feedback, tips, and announcements.
164+
We love community contributions! Get started by reading our [CONTRIBUTING.md](CONTRIBUTING.md).
170165

171166
---
172167

0 commit comments

Comments
 (0)