Add Cursor rules file

[adivate2021]

📝 Summary

Add Cursor rules file

🎯 Purpose

Helps Cursor better understand the codebase when debugging

[gemini-code-assist]

Hello @adivate2021, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello, gemini-code-assist here to provide a summary of this pull request. This PR, authored by adivate2021, aims to improve the understanding of the codebase for the Cursor AI tool. It achieves this by adding a dedicated rules file for the judgeval component within the .cursor/rules/ directory. This new file contains detailed documentation about the Judgeval project, which should provide valuable context to the AI when assisting with debugging or code navigation related to that part of the system.

Highlights

• Cursor AI Integration: Adds a configuration file specifically for the Cursor AI tool to enhance its understanding of the project structure and content.
• Judgeval Documentation: Includes comprehensive documentation about the 'Judgeval' component, covering its features, installation, usage examples (tracing, evaluations), self-hosting, and contribution guidelines.

Changelog

• .cursor/rules/judgeval_rules.mdc
  • Added a new file containing detailed documentation about the Judgeval project.
  • This file serves as a rules/context file for the Cursor AI tool.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A new file appears,
For AI's helpful ears,
Judgeval's docs clear,
Debugging is near,
Dispelling all coding fears.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new file .cursor/rules/judgeval_rules.mdc to provide context for the Cursor AI assistant. The intention to help Cursor understand the codebase is good. However, the content of the added file appears to be a direct copy of the project's README.md. While this provides a lot of context, it also introduces some maintainability concerns.

Summary of Findings

• Code Duplication: The content of .cursor/rules/judgeval_rules.mdc is a direct copy of README.md, creating a maintenance burden as changes to one will need to be manually replicated in the other.
• File Content Appropriateness: The file, intended as Cursor rules for debugging, contains a general project overview rather than targeted codebase information that might be more useful for debugging assistance.

Merge Readiness

The code changes introduce a significant maintainability issue due to the duplication of the README content. This high-severity issue should be addressed before merging. Additionally, consider whether the content is the most effective type of information for a Cursor 'rules' file.

[gemini-code-assist]

It looks like the content of this file is a direct copy of the project's README.md. While the goal is to help Cursor understand the codebase, maintaining two identical copies of the project description can lead to inconsistencies over time. If the README is updated, this file will also need manual updates, which is prone to errors. Is there a way to achieve the goal of providing context to Cursor without duplicating the entire README? Perhaps Cursor has a mechanism to reference the existing README, or maybe a more concise summary or specific instructions relevant to debugging would be more appropriate for a 'rules' file?

[gemini-code-assist]

This file is placed in the .cursor/rules directory and is intended to help Cursor understand the codebase for debugging. However, the content is a general overview of the project, its features, and how to get started. Does this level of detail in a 'rules' file effectively guide Cursor for debugging specific code issues? Perhaps the rules file could contain more targeted information, such as key directories, important classes/functions, or specific patterns that Cursor should be aware of when analyzing the code?

[alanzhang25]

LGTM!