Fix python version in community>Contributing #72
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gonzalesedwin1123, 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 updating and refining the documentation related to contributing to the project, specifically concerning the environment setup for building documentation. The changes aim to ensure the instructions are current and accurate, improving the developer experience for those contributing to the project's documentation.
Highlights
- Documentation Update: The recommended Python version for building documentation has been updated from 3.10 to 3.11.
- Build Instructions Refinement: The
pip install -r requirements.txtcommand was removed from the documentation build instructions, streamlining the process. - Code Block Correction: A code block type was corrected from
shelltobashfor consistency and accuracy. - File Cleanup: An extraneous HTML comment
-->was removed from the end of the contributing documentation file.
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 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
-
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.
Code Review
This pull request updates the recommended Python version for building the documentation from 3.10 to 3.11, and makes a few other small improvements to the contributing guide. The changes to remove a redundant command and fix a typo are good. However, updating to Python 3.11 might introduce build problems for contributors due to the libsass dependency, which does not have pre-built wheels for Python 3.11. My review includes a comment with a suggestion on how to address this potential issue.
| Python 3.11 should be used to build the documentation. You can install it using your package manager or by | ||
| following the instructions on the [pyenv GitHub page](https://github.com/pyenv/pyenv). |
There was a problem hiding this comment.
Updating the recommended Python version to 3.11 is a good goal. However, requirements.txt contains libsass==0.20.1, which may cause installation issues on Python 3.11. This version of libsass lacks pre-built wheels for Python 3.10+, meaning contributors would need a C compiler and the libsass C library installed to build it from source. This could be a significant barrier to contribution.
To ensure a smooth setup process for contributors, please consider one of the following options:
- Update the
libsassdependency to a more modern alternative that supports Python 3.11, such asdart-sass. - Revert this change to recommend Python 3.10, for which pre-built wheels for
libsassare available.
|
No description provided.