👓 Proof Reader Mode for Roo Code

Welcome to the Proof Reader Mode! A specialized custom mode for the Roo Code VS Code extension.

This mode acts as a world-class code proofreader and documentation architect. It's designed to automatically inspect, correct, and rewrite your source files to ensure linguistic consistency, professional documentation, and clean formatting—all without altering the core logic of your code.

---

✨ Features

• ✍️ Linguistic Consistency: Ensures all comments, docstrings, and text are in clear, professional English.
• 📚 Complete Docstrings: Automatically generates and completes professional docstrings and comments for classes and functions.
• 🧹 Code Readability: Improves code structure and readability by adjusting spacing and formatting.
• 📐 Formatting Consistency: Enforces consistent indentation and formatting across all source files.
• 🔒 Logic Preservation: Guarantees that no program logic or functionality is ever modified.

---

🚀 Getting Started

Prerequisites

You must have the Roo Code extension installed in Visual Studio Code.

Installation

1. Copy proof-reader-export.yaml
2. Edit global modes
3. Add this one (probably without the customModes root key)

---

💡 Usage & Examples

Example Prompts

Here are a few examples of how you can instruct the agent:

• For a single file:

  @src/utils/helpers.py

• For an entire directory:

  @src/components/

• For the whole project:

  Analyze the entire project.

• For a specific task:

  calculate_total function in @invoicing.py.

Example 1: Adding a Docstring

Before:

def add(a, b):
    # this function adds two numbers
    return a + b

After:

def add(a, b):
    """
    Calculates the sum of two numbers.

    Args:
        a (int): The first number.
        b (int): The second number.

    Returns:
        int: The sum of the two numbers.
    """
    return a + b

Example 2: Improving Formatting and Comments

Before:

// function to get user data
function getUser( id ){
let user=db.find(id);
return user
}

After:

/**
 * Fetches a user from the database by their ID.
 *
 * @param {number} id The unique identifier of the user.
 * @returns {object|null} The user object or null if not found.
 */
function getUser(id) {
    const user = db.find(id);
    return user;
}

---

🤖 How This README Was Created

This entire README.md file was generated by the Proof Reader agent itself!

You can use this mode not only to correct code but also to generate high-quality documentation for your projects. Just provide a prompt describing what you need.

Example Prompt to create a README:

"Create a fancy README.md for my project. It's a custom mode for Roo Code that acts as a proofreader. Include features, installation steps, and usage examples."

---

🛠️ Technical Notes

• This mode has been primarily tested with the gemini-2.5-flash model, which offers a great balance of speed and quality for proofreading tasks. Other models may also work but could produce slightly different results.

---

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

👤 Author

Grégoire Compagnon (obeone)

• Email: [email protected]
• GitHub: @obeone

---

📄 License

This project is licensed under the MIT License