אם יש לכם קבוצה מותאמת אישית של שיטות מומלצות או מוסכמות שאתם רוצים ש-Gemini Code Assist ב-GitHub יבדוק או יפעל לפיהן כשאתם מבצעים סקירת קוד, אתם יכולים להוסיף קובץ styleguide.md Markdown לתיקיית הבסיס .gemini/ של המאגר.
משתמשים בגרסה לארגונים של Gemini Code Assist ב-GitHub יכולים להשתמש במסוף Google Cloud כדי להוסיף מידע על מדריך סגנון לשימוש בכמה מאגרים.
בשני המקרים, מדריך הסגנון נחשב לקובץ Markdown רגיל, והוא מרחיב את ההנחיה הרגילה שבה משתמש Gemini Code Assist ב-GitHub.
דפוסים סטנדרטיים של בקרת קוד
אם לא מציינים מדריכי סגנון מותאמים אישית, אלה הקטגוריות העיקריות של תחומים שבהם Gemini Code Assist מתמקד בבדיקת הקוד:
נכונות: מוודא שהקוד פועל כמצופה ומטפל במקרים חריגים, בודק שגיאות לוגיות, תנאי מירוץ או שימוש לא נכון ב-API.
יעילות: זיהוי צווארי בקבוק פוטנציאליים בביצועים או תחומים לאופטימיזציה, כמו לולאות מוגזמות, דליפות זיכרון, מבני נתונים לא יעילים, חישובים מיותרים, רישום מוגזם ביומן ומניפולציה לא יעילה של מחרוזות.
יכולת תחזוקה: הערכה של קריאות הקוד, המודולריות וההקפדה על ניבים של השפה ושיטות מומלצות. הכלי מזהה שמות לא טובים של משתנים, פונקציות ומחלקות, חוסר הערות או תיעוד, קוד מורכב, כפילויות בקוד, פורמט לא עקבי ומספרים קסומים.
אבטחה: מזהה נקודות חולשה פוטנציאליות בטיפול בנתונים או באימות קלט, כמו אחסון לא מאובטח של מידע אישי רגיש, מתקפות הזרקה, אמצעי בקרה לא מספיקים לגישה, זיוף בקשות באתרים שונים (CSRF) והפניות לא מאובטחות לאובייקטים ישירים (IDOR).
שונות: נושאים אחרים נלקחים בחשבון כשבודקים את בקשת המיזוג, כמו בדיקות, ביצועים, יכולת הרחבה, מודולריות ושימוש חוזר, ורישום ביומן ומעקב אחר שגיאות.
מדריך סגנון לדוגמה
לקובץ styleguide.md אין סכימה מוגדרת. במקום זאת, זוהי תיאור בשפה טבעית של האופן שבו אתם רוצים ש-Gemini Code Assist יבנה את ביקורות הקוד שלו. קטע הקוד הבא הוא דוגמה לקובץ styleguide.md:
# Company X Python Style Guide
## Introduction
This style guide outlines the coding conventions for Python code developed at
Company X. It's based on PEP 8, but with some modifications to address
specific needs and preferences within our organization.
## Key Principles
* **Readability:** Code should be easy to understand for all team members.
* **Maintainability:** Code should be easy to modify and extend.
* **Consistency:** Adhering to a consistent style across all projects
improves collaboration and reduces errors.
* **Performance:** While readability is paramount, code should be efficient.
## Deviations from PEP 8
### Line Length
* **Maximum line length:** 100 characters (instead of PEP 8's 79).
* Modern screens allow for wider lines, improving code readability in
many cases.
* Many common patterns in our codebase, like long strings or URLs, often
exceed 79 characters.
### Indentation
* **Use 4 spaces per indentation level.** (PEP 8 recommendation)
### Imports
* **Group imports:**
* Standard library imports
* Related third party imports
* Local application/library specific imports
* **Absolute imports:** Always use absolute imports for clarity.
* **Import order within groups:** Sort alphabetically.
### Naming Conventions
* **Variables:** Use lowercase with underscores (snake_case): `user_name`, `total_count`
* **Constants:** Use uppercase with underscores: `MAX_VALUE`, `DATABASE_NAME`
* **Functions:** Use lowercase with underscores (snake_case): `calculate_total()`, `process_data()`
* **Classes:** Use CapWords (CamelCase): `UserManager`, `PaymentProcessor`
* **Modules:** Use lowercase with underscores (snake_case): `user_utils`, `payment_gateway`
### Docstrings
* **Use triple double quotes (`"""Docstring goes here."""`) for all docstrings.**
* **First line:** Concise summary of the object's purpose.
* **For complex functions/classes:** Include detailed descriptions of
parameters, return values, attributes, and exceptions.
* **Use Google style docstrings:** This helps with automated documentation generation.
```python
def my_function(param1, param2):
"""Single-line summary.
More detailed description, if necessary.
Args:
param1 (int): The first parameter.
param2 (str): The second parameter.
Returns:
bool: The return value. True for success, False otherwise.
Raises:
ValueError: If `param2` is invalid.
"""
# function body here
```
### Type Hints
* **Use type hints:** Type hints improve code readability and help catch
errors early.
* **Follow PEP 484:** Use the standard type hinting syntax.
### Comments
* **Write clear and concise comments:** Explain the "why" behind the code,
not just the "what".
* **Comment sparingly:** Well-written code should be self-documenting where
possible.
* **Use complete sentences:** Start comments with a capital letter and use
proper punctuation.
### Logging
* **Use a standard logging framework:** Company X uses the built-in
`logging` module.
* **Log at appropriate levels:** DEBUG, INFO, WARNING, ERROR, CRITICAL
* **Provide context:** Include relevant information in log messages to aid
debugging.
### Error Handling
* **Use specific exceptions:** Avoid using broad exceptions like `Exception`.
* **Handle exceptions gracefully:** Provide informative error messages and
avoid crashing the program.
* **Use `try...except` blocks:** Isolate code that might raise exceptions.
## Tooling
* **Code formatter:** [Specify formatter, e.g., Black] - Enforces
consistent formatting automatically.
* **Linter:** [Specify linter, e.g., Flake8, Pylint] - Identifies potential
issues and style violations.
ניהול מדריכי סגנון בכמה מאגרים
אם יש לכם את גרסת הארגון של Gemini Code Assist ב-GitHub, אתם יכולים להחיל מדריך סגנון אחד על כמה מאגרים. המאגרים מקובצים לפי חיבור Developer Connect, וניהול מדריך הסגנון המשותף שלהם מתבצע דרך מסוף Google Cloud.
אם מאגר מנוהל כחלק מקבוצה אבל יש לו גם קובץ styleguide.md משלו, קובץ ה-styleguide.md של המאגר משולב עם מדריך הסגנון של הקבוצה.
בשלבים הבאים מוסבר איך משתמשים בגרסה הארגונית יכולים לשלוט במדריך סגנון אחד בכמה מאגרים. אנחנו יוצאים מנקודת הנחה שכבר הגדרתם את Gemini Code Assist ב-GitHub.
במסוף Google Cloud, עוברים לדף Agents & Tools של Gemini Code Assist.
בקטע סוכנים, מאתרים את הכרטיס ניהול קוד מקור של Code Assist ולוחצים על מתקדם.
החלונית עריכת ניהול קוד מקור של Code Assist נפתחת.
בטבלה Connections, לוחצים על שם החיבור שרוצים להחיל עליו את מדריך הסגנון.
ייפתח דף הפרטים של החיבור.
בכרטיסייה Style guide (הנחיות סגנון), מוסיפים את הנחיות הסגנון שרוצים שהמאגרים שמשויכים לחיבור הזה ישתמשו בהן.
לוחצים על שמירה.
המאמרים הבאים
- שינוי ההגדרה של Gemini Code Assist ב-GitHub.