-
Notifications
You must be signed in to change notification settings - Fork 0
Add hgrp.pm/ProjectStatus.json, Windsurf and Cline rules #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @dholzric, 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!
Summary of Changes
This pull request, initiated by an automated process, introduces a new JSON file (hgrp.pm/ProjectStatus.json) to track the status of the 'gitdiagram' project, including tasks and their completion percentages. Additionally, it adds a Cline rule (.cline/rules/update-project-status-on-task-change.yaml) to automatically update the project status in the JSON file whenever changes are detected. The rule uses a script (scripts/updateProjectStatus.js) to calculate the overall project completion percentage and then commits and pushes the updated JSON file.
Highlights
- Project Status Tracking: Adds a
ProjectStatus.jsonfile to track project details like tasks, status, and overall completion. - Cline Automation Rule: Introduces a Cline rule to automatically update the
ProjectStatus.jsonfile on changes, ensuring real-time status updates. - Automated Updates: The Cline rule uses a script to calculate and commit changes, automating the project status update process.
Changelog
- .cline/rules/update-project-status-on-task-change.yaml
- Creates a new Cline rule to monitor changes to
hgrp.pm/ProjectStatus.json. - Configures the rule to run a script (
scripts/updateProjectStatus.js) to update the project status. - Sets up the rule to automatically commit and push changes to the repository.
- Creates a new Cline rule to monitor changes to
- hgrp.pm/ProjectStatus.json
- Creates a new JSON file to store project status information.
- Defines the project name, last updated timestamp, tasks with their status and completion percentage, and overall project completion percentage.
- Initializes the project with three tasks: 'Design API', 'Build UI', and 'Write specs', all with 'todo' status and 0% completion.
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 JSON file's born,
Status tracked till early morn,
Cline rules now guide,
Progress quantified,
Automation's gentle horn.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a new Cline rule and a ProjectStatus.json file to automate project status updates based on file changes. The changes seem straightforward, but I have a few suggestions to improve the rule's robustness and the project status file's structure.
Summary of Findings
- Missing error handling in script execution: The Cline rule executes a script but doesn't handle potential errors during script execution. This could lead to silent failures and incorrect project status updates.
- Hardcoded email and user name: The Cline rule uses hardcoded email and user names for git commits. This should be configurable or derived from the environment to avoid issues when running in different contexts.
Merge Readiness
The pull request introduces important automation functionality. However, the identified issues regarding error handling and hardcoded values should be addressed before merging to ensure the reliability and flexibility of the automation. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
Automated PR to add status tracking and automation rules.