Skip to content

docs: Add contributing guide to sidebar navigation#175

Merged
hannesrudolph merged 1 commit into
mainfrom
contributions
May 7, 2025
Merged

docs: Add contributing guide to sidebar navigation#175
hannesrudolph merged 1 commit into
mainfrom
contributions

Conversation

@hannesrudolph
Copy link
Copy Markdown
Collaborator

@hannesrudolph hannesrudolph commented May 7, 2025

Important

Add contributing.md to the documentation and update sidebars.ts to include it in the sidebar navigation.

  • Documentation:
    • Add contributing.md to provide guidelines for contributing to Roo Code.
    • Includes sections on code of conduct, project roadmap, community engagement, contribution types, issue-first approach, development setup, and PR process.
  • Sidebar Navigation:
    • Update sidebars.ts to include contributing.md in the sidebar under the main navigation.

This description was created by Ellipsis for 9299df4. You can customize this summary. It will automatically update as commits are pushed.

@hannesrudolph hannesrudolph requested review from cte and mrubens as code owners May 7, 2025 01:10
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label May 7, 2025
@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
roo-code-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 1:11am

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label May 7, 2025
@hannesrudolph hannesrudolph merged commit 786fa03 into main May 7, 2025
3 checks passed
@hannesrudolph hannesrudolph deleted the contributions branch May 7, 2025 01:12
Copy link
Copy Markdown
Contributor

@ellipsis-dev ellipsis-dev Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Changes requested ❌

Reviewed everything up to 9299df4 in 2 minutes and 1 seconds. Click for details.
  • Reviewed 224 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 4 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/contributing.md:205
  • Draft comment:
    Consider adding a trailing newline at the end of the file to adhere to style guidelines.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 0% vs. threshold = 50% While having a trailing newline is a common style guideline, this kind of formatting issue should be handled automatically by ESLint/Prettier rather than manual code review comments. Our rules specifically state that we should let automated tools handle code style issues. Additionally, this is a very minor formatting issue that doesn't impact functionality. The comment is technically correct - many style guides do recommend trailing newlines. And this is a new file, so we could catch this early. However, our rules explicitly state that code style issues should be handled by ESLint and Prettier with pre-commit hooks, not manual review comments. Making style comments creates noise and reduces focus on more important issues. Delete this comment. Style formatting like trailing newlines should be handled automatically by ESLint/Prettier, not manual review comments.
2. sidebars.ts:132
  • Draft comment:
    Ensure the new 'contributing' sidebar entry is correctly positioned and links to the intended document.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 50% None
3. sidebars.ts:132
  • Draft comment:
    Added 'contributing' to the sidebar. Ensure that the doc ID matches the filename (defaults to 'contributing').
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
4. docs/contributing.md:140
  • Draft comment:
    Typographical error: The installation command on line 140 uses 'roo-cline-.vsix'. This seems like a typo — it likely should be 'roo-code-.vsix' to match the rest of the project naming. Please verify and correct this string.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_qiBSnkMf6m7M09td

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Comment thread docs/contributing.md
Alternatively, build and install a `.vsix`:
```sh
npm run build
code --install-extension bin/roo-cline-.vsix
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The VS Code extension install command (roo-cline-.vsix) might be a typo. Confirm if it should be roo-code-.vsix or another name.

Suggested change
code --install-extension bin/roo-cline-.vsix
code --install-extension bin/roo-code-.vsix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant