Conversation
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 updates the project's development tooling by replacing 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
Ignored Files
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.
Code Review
This pull request transitions the project from using pre-commit to prek for pre-commit hooks. The changes update the developer documentation in README.md and the project dependencies in pyproject.toml. My review focuses on ensuring a smooth transition for developers. I've suggested an improvement to the README.md to clarify the change for developers setting up their environment. I've also suggested keeping both pre-commit and prek as development dependencies temporarily to align with the goal of a non-disruptive transition, as mentioned in the pull request description.
Note: Security Review has been skipped due to the limited scope of the PR.
| ``` | ||
|
|
||
| Before committing changes, initialize `pre-commit` with `pre-commit install`. This will format code with each commit to keep the style consistent. _Neurodocker_ uses `black` for formatting. | ||
| Before committing changes, initialize `prek` with `prek install`, or `pre-commit` with `pre-commit install`. This will format code with each commit to keep the style consistent. _Neurodocker_ uses `black` for formatting. |
There was a problem hiding this comment.
This phrasing could be confusing for developers, as pre-commit is no longer installed as a development dependency. It would be clearer to explicitly state that prek is the new default and that pre-commit must be installed separately if a developer wishes to use it.
| Before committing changes, initialize `prek` with `prek install`, or `pre-commit` with `pre-commit install`. This will format code with each commit to keep the style consistent. _Neurodocker_ uses `black` for formatting. | |
| Before committing changes, initialize `prek` with `prek install` (now a dev dependency), or `pre-commit` (if installed separately) with `pre-commit install`. This will format code with each commit to keep the style consistent. _Neurodocker_ uses `black` for formatting. |
| "coverage[toml]", | ||
| "mypy", | ||
| "pre-commit", | ||
| "prek", |
There was a problem hiding this comment.
The PR description mentions that developers can switch at their own pace without disruption. By replacing pre-commit with prek, developers who reinstall their dependencies will lose pre-commit, which could be disruptive to their workflow. To allow for a smoother transition, consider including both pre-commit and prek in the development dependencies for a period of time.
| "prek", | |
| "pre-commit", | |
| "prek", |
Attempt to use
prekinstead ofpre-commit.This PR switches from
pre-committoprekmostly in CI.Since
prekis a drop-in replacement forpre-commit, either of them can be used on developers' computers, based on the same.pre-commit-config.yamlfile, so that developer can change at their pace without disruption.