Conversation
Summary of ChangesHello @jeffcarp, 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 enhances the project's governance and onboarding process for new contributors by introducing formal documentation for contributing guidelines and a code of conduct. These changes centralize important information, making it easier for individuals to understand how to contribute effectively and what behavioral standards are expected within the community. 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.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces standard CONTRIBUTING.md and CODE_OF_CONDUCT.md documents, which is a great addition for an open-source project. The README.md is also updated to link to these new, more detailed guides, which cleans up the main project page. The changes are well-structured. I've added a couple of suggestions to improve the clarity of the contribution guidelines and to note the version of the Code of Conduct.
| This Code of Conduct is adapted from the Contributor Covenant, version 1.4, | ||
| available at | ||
| https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |
There was a problem hiding this comment.
This Code of Conduct is based on version 1.4 of the Contributor Covenant from 2016. While this is acceptable, you might consider updating to a more recent version like 2.1 (from 2021). The newer versions include some clarifications and are more commonly adopted in new projects. This would require updating the body of this document to match the text of the newer version, which can be found at https://www.contributor-covenant.org/version/2/1/code_of_conduct/.
| ### Code quality and testing | ||
|
|
||
| Before submitting a pull request, please ensure your changes pass linting and unit tests. | ||
|
|
||
| - **Linting:** We use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. Run it with: | ||
| ```bash | ||
| ruff check . | ||
| ``` | ||
| - **Testing:** We use [Pytest](https://docs.pytest.org/) for unit tests. Run them with: | ||
| ```bash | ||
| pytest | ||
| ``` |
There was a problem hiding this comment.
The instructions for code quality and testing could be clearer about the role of pre-commit. The previous instructions in README.md explained that pre-commit automates linting, but that context is lost here. This suggestion clarifies that pre-commit runs checks automatically on commit and provides the idiomatic command to run them manually, which is clearer for contributors.
| ### Code quality and testing | |
| Before submitting a pull request, please ensure your changes pass linting and unit tests. | |
| - **Linting:** We use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. Run it with: | |
| ```bash | |
| ruff check . | |
| ``` | |
| - **Testing:** We use [Pytest](https://docs.pytest.org/) for unit tests. Run them with: | |
| ```bash | |
| pytest | |
| ``` | |
| ### Code quality and testing | |
| After installing pre-commit hooks, linting and formatting checks will run automatically on every commit. Before submitting a pull request, please ensure all checks and unit tests pass. | |
| You can also run the checks manually: | |
| - **Linting & Formatting:** To run checks on all files, use: | |
| ```bash | |
| pre-commit run --all-files |
- Testing: We use Pytest for unit tests. Run them with:
pytest
<details>
<summary>References</summary>
1. The repository style guide emphasizes minimizing cognitive load for users and providing good documentation (lines 50, 103). The suggested change improves the clarity of the contribution workflow, reducing potential confusion for new contributors. <sup>([link](https://github.com/keras-team/remote/blob/main/.gemini/styleguide.md))</sup>
</details>
2 participants
Adapted from https://github.com/google/parallax/tree/main/docs