अगर आपके पास सबसे सही तरीकों या समझौतों का कोई कस्टम सेट है और आपको Gemini Code Assist की मदद से इसकी जांच करनी है, तो अपने रिपॉज़िटरी के .gemini/ रूट फ़ोल्डर में styleguide.md फ़ाइल जोड़ें. इस फ़ाइल को एक सामान्य टेक्स्ट फ़ाइल के तौर पर माना जाता है. साथ ही, यह Gemini Code Assist के इस्तेमाल किए जाने वाले स्टैंडर्ड प्रॉम्प्ट को बड़ा करती है.
कोड की समीक्षा के स्टैंडर्ड पैटर्न
जब कस्टम स्टाइल गाइड तय नहीं की जाती हैं, तो Gemini Code Assist कोड की समीक्षा इन मुख्य कैटगरी पर फ़ोकस करता है:
सही होना: यह पक्का करता है कि कोड सही तरीके से काम करता है और असामान्य स्थितियों को मैनेज करता है. साथ ही, लॉजिक से जुड़ी गड़बड़ियों, रेस कंडीशन या एपीआई के गलत इस्तेमाल की जांच करता है.
परफ़ॉर्मेंस: परफ़ॉर्मेंस में रुकावट डालने वाले संभावित फ़ैक्टर या ऑप्टिमाइज़ेशन के लिए ज़रूरी चीज़ों की पहचान करता है. जैसे, ज़रूरत से ज़्यादा लूप, मेमोरी लीक, डेटा स्ट्रक्चर का सही तरीके से इस्तेमाल न करना, ग़ैर-ज़रूरी कैलकुलेशन, ज़रूरत से ज़्यादा लॉगिंग, और स्ट्रिंग में बदलाव करने का गलत तरीका.
मेंटेन करने की सुविधा: इससे कोड को पढ़ने में आसानी, मॉड्यूलरिटी, और भाषा के मुहावरे और सबसे सही तरीकों का पालन करने का आकलन किया जाता है. यह वैरिएबल, फ़ंक्शन, और क्लास के लिए गलत नाम रखने, टिप्पणियों या दस्तावेज़ों की कमी, जटिल कोड, कोड का डुप्लीकेट होना, फ़ॉर्मैट में अंतर, और मैजिक नंबर को टारगेट करता है.
सुरक्षा: डेटा को मैनेज करने या इनपुट की पुष्टि करने में संभावित कमजोरियों की पहचान करता है. जैसे, संवेदनशील डेटा को असुरक्षित तरीके से सेव करना, इंजेक्शन अटैक, ऐक्सेस कंट्रोल की कमी, किसी दूसरी साइट से किए गए फ़र्ज़ी अनुरोध (सीएसआरएफ़), और असुरक्षित डायरेक्ट ऑब्जेक्ट रेफ़रंस (आईडीओआर).
अन्य: पुश अनुरोध की समीक्षा करते समय, अन्य विषयों पर भी विचार किया जाता है. जैसे, जांच, परफ़ॉर्मेंस, स्केलेबिलिटी, मॉड्यूलरिटी, और फिर से इस्तेमाल करने की सुविधा. साथ ही, गड़बड़ी को लॉग करने और मॉनिटर करने की सुविधा भी शामिल है.
कॉन्फ़िगरेशन फ़ाइलें जोड़ना
.gemini/ फ़ोल्डर में, Gemini Code Assist से जुड़ी कॉन्फ़िगरेशन फ़ाइलें होस्ट की जाती हैं. जैसे, config.yaml और styleguide.md.
config.yaml फ़ाइल में, कॉन्फ़िगर की जा सकने वाली कई सुविधाएं होती हैं. इन्हें चालू या बंद किया जा सकता है. styleguide.md टेक्स्ट फ़ाइल, स्टाइल गाइड होती है. इसमें Gemini Code Assist को कुछ खास नियमों के बारे में निर्देश दिए जाते हैं. कोड की समीक्षा करते समय, आपको इन नियमों का पालन करना होता है.
इन कॉन्फ़िगरेशन फ़ाइलों को जोड़ने के लिए, उन्हें अपनी रिपॉज़िटरी के .gemini/ फ़ोल्डर में बनाएं. साथ ही, रेफ़रंस के तौर पर नीचे दी गई टेबल का इस्तेमाल करें:
नीचे दिया गया कोड स्निपेट, डिफ़ॉल्ट सेटिंग वाली config.yaml फ़ाइल का उदाहरण है. अगर आपने कोई सेटिंग शामिल नहीं की है, तो Gemini Code Assist डिफ़ॉल्ट सेटिंग का इस्तेमाल करता है. अपनी config.yaml फ़ाइल बनाने के लिए, इस स्निपेट का इस्तेमाल टेंप्लेट के तौर पर किया जा सकता है:
have_fun: true
code_review:
disable: false
comment_severity_threshold: MEDIUM
max_review_comments: -1
pull_request_opened:
help: false
summary: true
code_review: true
नीचे दिया गया कोड स्निपेट, पसंद के मुताबिक सेटिंग वाली config.yaml फ़ाइल का उदाहरण है:
$schema: "http://json-schema.org/draft-07/schema#"
title: RepoConfig
description: Configuration for Gemini Code Assist on a repository. All fields are optional and have default values.
type: object
properties:
have_fun:
type: boolean
description: Enables fun features such as a poem in the initial pull request summary. Default: true.
code_review:
type: object
description: Configuration for code reviews. All fields are optional and have default values.
properties:
disable:
type: boolean
description: Disables Gemini from acting on pull requests. Default: false.
comment_severity_threshold:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: The minimum severity of review comments to consider. Default: MEDIUM.
max_review_comments:
type: integer
format: int64
description: The maximum number of review comments to consider. Use -1 for unlimited. Default: -1.
pull_request_opened:
type: object
description: Configuration for pull request opened events. All fields are optional and have default values.
properties:
help:
type: boolean
description: Posts a help message on pull request open. Default: false.
summary:
type: boolean
description: Posts a pull request summary on the pull request open. Default: true.
code_review:
type: boolean
description: Posts a code review on pull request open. Default: true.
यहां दिया गया कोड स्निपेट, 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.
# Example
```python
"""Module for user authentication."""
import hashlib
import logging
import os
from companyx.db import user_database
LOGGER = logging.getLogger(__name__)
def hash_password(password: str) -> str:
"""Hashes a password using SHA-256.
Args:
password (str): The password to hash.
Returns:
str: The hashed password.
"""
salt = os.urandom(16)
salted_password = salt + password.encode('utf-8')
hashed_password = hashlib.sha256(salted_password).hexdigest()
return f"{salt.hex()}:{hashed_password}"
def authenticate_user(username: str, password: str) -> bool:
"""Authenticates a user against the database.
Args:
username (str): The user's username.
password (str): The user's password.
Returns:
bool: True if the user is authenticated, False otherwise.
"""
try:
user = user_database.get_user(username)
if user is None:
LOGGER.warning("Authentication failed: User not found - %s", username)
return False
stored_hash = user.password_hash
salt, hashed_password = stored_hash.split(':')
salted_password = bytes.fromhex(salt) + password.encode('utf-8')
calculated_hash = hashlib.sha256(salted_password).hexdigest()
if calculated_hash == hashed_password:
LOGGER.info("User authenticated successfully - %s", username)
return True
else:
LOGGER.warning("Authentication failed: Incorrect password - %s", username)
return False
except Exception as e:
LOGGER.error("An error occurred during authentication: %s", e)
return False