chore: consolidate cursor rules at workspace level and enforce Python 3.12+#2286
chore: consolidate cursor rules at workspace level and enforce Python 3.12+#2286
Conversation
… 3.12+ - Create workspace-level cursor rules (python.mdc, documentation.mdc, guidelines.mdc) - Remove redundant giskard-checks rules (00-code-clean, 01-code-quality, 10-python) - Trim remaining giskard-checks rules (02-project, 03-development) to remove duplication - Delete CODEMAP.md (replaced by cursor rules and docstrings) - Bump giskard-agents requires-python from >=3.11 to >=3.12 - Remove `from __future__ import annotations` from 12 source files (unnecessary with 3.12+)
Summary of ChangesHello, I'm Gemini Code Assist1! 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! This pull request significantly refactors the project's development guidelines and Python environment. By centralizing cursor rules and enforcing Python 3.12+, it aims to standardize coding practices, improve documentation consistency, and leverage modern Python features. These changes streamline the development workflow and reduce redundant documentation efforts, ensuring a more cohesive and up-to-date codebase. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.gh.umua.top/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a great initiative to consolidate and standardize the development guidelines by introducing workspace-level cursor rules and enforcing Python 3.12+. The changes, including the removal of redundant rule files, deletion of CODEMAP.md, and the consistent removal of unnecessary from __future__ import annotations imports, significantly improve the project's structure and maintainability. The code changes look solid and align well with the stated goals. One minor point of feedback: the new documentation rule (.cursor/rules/documentation.mdc) specifies NumPy-style docstrings, and the code changes seem to adhere to this. However, the PR description's checklist mentions "docstring in Google format". This is a small inconsistency, and it would be good to align the PR template with the new project standards.
|
|
||
| scenario_name: str = Field(..., description="Scenario name") | ||
| steps: list[TestCaseResult] # TODO: rename to test_cases | ||
| steps: list["TestCaseResult"] # TODO: rename to test_cases |
There was a problem hiding this comment.
The new documentation guidelines in .cursor/rules/documentation.mdc state that TODO comments should not be left without a linked issue or a clear owner. Please consider creating a GitHub issue for this planned refactoring and referencing it in the comment (e.g., # TODO(GH-123): rename to test_cases) or removing the TODO if it's not a priority.
References
- The documentation guidelines state that TODO comments should not be left without a linked issue or a clear owner. (link)
|
|
||
| ## Public API Docstrings | ||
|
|
||
| Every public class, method, and function **must** have a NumPy-style docstring that includes: |
There was a problem hiding this comment.
Let's also update the PR template based on gemini comment (.github/PULL_REQUEST_TEMPLATE.md)
However, the PR description's checklist mentions "docstring in Google format".
|
This also solve #2278 |
2 participants
from __future__ import annotationsfrom 12 source files (unnecessary with 3.12+)@kevinmessiaen What do you think of those global simple rules for no ?
Description
Related Issue
from __future__ import annotations#2278Type of Change
Checklist
CODE_OF_CONDUCT.mddocument.CONTRIBUTING.mdguide.pdm.lockrunningpdm update-lock(only applicable whenpyproject.tomlhas beenmodified)