mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
docs: enhance contributing guide with setup instructions for first time contributors (#1183)
* docs: enhance contributing guide with setup instructions - Add explicit VS Code extension setup steps - Clarify local development workflow - Update code quality section with formatting details * Remove npm run watch instruction * Fix format command * Copy --------- Co-authored-by: Nick Baumann <nickbaumann@Nicks-MacBook-Pro.local> Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com>
This commit is contained in:
parent
9720d0c610
commit
f6c19c29a6
1 changed files with 16 additions and 2 deletions
|
|
@ -16,6 +16,19 @@ Looking for a good first contribution? Check out issues labeled ["good first iss
|
|||
|
||||
If you're planning to work on a bigger feature, please create an issue first so we can discuss whether it aligns with Cline's vision.
|
||||
|
||||
## Development Setup
|
||||
|
||||
1. **VS Code Extensions**
|
||||
|
||||
- When opening the project, VS Code will prompt you to install recommended extensions
|
||||
- These extensions are required for development - please accept all installation prompts
|
||||
- If you dismissed the prompts, you can install them manually from the Extensions panel
|
||||
|
||||
2. **Local Development**
|
||||
- Run `npm install` to install dependencies
|
||||
- Run `npm run test` to run tests locally
|
||||
- Before submitting PR, run `npm run format:fix` to format your code
|
||||
|
||||
## Writing and Submitting Code
|
||||
|
||||
Anyone can contribute code to Cline, but we ask that you follow these guidelines to ensure your contributions can be smoothly integrated:
|
||||
|
|
@ -28,8 +41,9 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines
|
|||
|
||||
2. **Code Quality**
|
||||
|
||||
- Run `npm run lint` to ensure code follows our style guidelines
|
||||
- Run `npm run format` to format your code with Prettier
|
||||
- Run `npm run lint` to check code style
|
||||
- Run `npm run format` to automatically format code
|
||||
- All PRs must pass CI checks which include both linting and formatting
|
||||
- Address any ESLint warnings or errors before submitting
|
||||
- Follow TypeScript best practices and maintain type safety
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue