-
Notifications
You must be signed in to change notification settings - Fork 0
docs: CI required checks + SQLx offline notes #28
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
Conversation
… local helper tips
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.
Pull Request Overview
This PR adds documentation for CI required checks and SQLx offline handling policies to improve developer understanding of the build pipeline.
- Adds comprehensive documentation of CI required checks that protect the main branch
- Documents SQLx offline cache validation policy and failure handling procedures
- Includes local development helpers and git hook setup instructions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds detailed CI required checks section and clarifies SQLx PR comment behavior |
| AGENTS.md | Adds concise CI checks overview and SQLx policy documentation for agents |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Summary of ChangesHello @zensgit, 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 focuses on enhancing and clarifying the project's documentation regarding continuous integration (CI) processes and SQLx database interaction policies. It provides clear guidelines for the required checks on the Highlights
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
|
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 adds valuable documentation regarding the CI required checks and the SQLx offline cache policy. The updates to AGENTS.md and README.md are clear and will be helpful for developers. I've provided a couple of minor suggestions for AGENTS.md to improve consistency and readability. Overall, a good contribution to the project's documentation.
| - `make format` / `make lint` Auto‑format & static analysis | ||
|
|
||
| CI required checks (main): | ||
| - `Flutter Tests`, `Rust API Tests` |
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.
| - `Flutter Tests`, `Rust API Tests` | ||
| - `Rust API Clippy (blocking)` (`-D warnings`) | ||
| - `Rustfmt Check` (blocking) | ||
| - `Cargo Deny Check` |
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.
No description provided.