Skip to content

Conversation

@richardwhiteii
Copy link

@richardwhiteii richardwhiteii commented Feb 15, 2025

Description

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

I loaded the examples and ran them.

Checklist:

  • [x ] My code follows the patterns of this project
  • [ x] I have performed a self-review of my own code
  • [x ] I have commented my code, particularly in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation

Additional context

I wanted to contribute and didn't see information on the exact json format based on the code.

Related Issues

None

Reviewers

TBD


Important

Adds documentation for .roomodes feature and a new issue template for tracking fork changes.

  • Documentation:
    • Adds README-roomodes.md detailing the .roomodes feature for defining project-specific custom modes in Roo-Code.
    • Includes instructions for creating .roomodes file, defining modes, and precedence over global settings.
    • Provides examples for adding new modes, overriding existing modes, and modes with file restrictions.
  • Issue Template:
    • Adds simpleissue.yaml for creating issues to track changes in forks.

This description was created by Ellipsis for 6f6f244. It will automatically update as commits are pushed.

Fixes #8

Add detailed documentation for the `.roomodes` feature in a new `README-roomodes.md` file.

* **Overview**: Describe the `.roomodes` feature and its purpose.
* **Creating and Managing Custom Modes**: Provide step-by-step instructions on how to create and manage custom modes in the `.roomodes` file.
* **Precedence of .roomodes over Global Settings**: Explain how project-specific modes in `.roomodes` take precedence over global settings.
* **Examples of Valid .roomodes Configurations**: Include examples of valid `.roomodes` configurations, such as adding a new mode, overriding an existing mode, and a mode with file restrictions.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/richardwhiteii/Roo-Code/issues/8?shareId=XXXX-XXXX-XXXX-XXXX).
@changeset-bot
Copy link

changeset-bot bot commented Feb 15, 2025

⚠️ No Changeset found

Latest commit: 6f6f244

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mrubens
Copy link
Collaborator

mrubens commented Feb 16, 2025

Hi, thanks for the contribution! I’ve moved the user-facing documentation to Roo-Code-Docs (which backs https://docs.roocode.com). Can you take a look at the content there and open a PR with any changes you want to propose to https://github.com/RooVetGit/Roo-Code-Docs/blob/main/docs/advanced-usage/custom-modes.md? Thank you!

@mrubens mrubens closed this Feb 16, 2025
@richardwhiteii richardwhiteii deleted the add-roomodes-docs branch February 17, 2025 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants