docs: clarify preflight instructions in GEMINI.md

[NTaylorMullen]

Summary

Clarifies the preflight instructions in GEMINI.md to be more nuanced about when to run npm run preflight.

Details

Because npm run preflight takes a significantly long time to execute, the updated guidance recommends:

1. Running it only at the very end of code implementation tasks.
2. Using faster, targeted commands like npm run test or npm run lint when iterating on fixes.
3. Skipping the full preflight suite completely for simple, non-code changes like prompting and documentation.

Related Issues

None.

How to Validate

Review the updated text in GEMINI.md for clarity and correctness.

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed)
• Noted breaking changes (if any)
• Validated on required platforms/methods:
  • MacOS
    • npm run
    • npx
    • Docker
    • Podman
    • Seatbelt
  • Windows
    • npm run
    • npx
    • Docker
  • Linux
    • npm run
    • npx
    • Docker

[gemini-code-assist]

Summary of Changes

Hello @NTaylorMullen, 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!

This pull request refines the developer workflow documentation by providing clearer, more efficient guidelines for using the npm run preflight command. The changes aim to reduce unnecessary waiting times during development by suggesting when to run the comprehensive preflight checks versus when to use more targeted validation tools or skip checks entirely for minor changes.

Highlights

• Clarified npm run preflight usage: Updated instructions in GEMINI.md to provide more nuanced guidance on when to execute the npm run preflight command.
• Optimized preflight workflow: Recommended running preflight only at the final stage of code implementation tasks due to its long execution time.
• Suggested targeted commands for iteration: Advised using faster, specific commands like npm run test or npm run lint for iterating on fixes after a preflight failure.
• Skipped preflight for non-code changes: Recommended skipping the full preflight suite for simple changes such as documentation or prompting updates, relying instead on PR validation.

Changelog

• GEMINI.md
  • Updated the description for npm run preflight to include guidance on when to run it, suggesting it for the end of code implementation tasks.
  • Added recommendations to use faster, targeted commands for iterating on fixes after a preflight failure.
  • Included advice to skip preflight for simple, non-code changes like documentation updates.

Activity

• The author has completed the initial documentation update and marked the relevant checklist items.
• The author has validated the changes on MacOS using npm run.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

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 updates the GEMINI.md file to provide clearer and more practical instructions for using the npm run preflight command. The change advises developers to run this time-consuming script only at the end of a task and suggests using more targeted commands for iterative fixes. This is a helpful clarification that should improve the development workflow. The change is well-scoped and looks good.

[github-actions]

Size Change: -2 B (0%)

Total Size: 24.5 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	24.5 MB	-2 B (0%)
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[gsquared94]

lgtm!