gsudarshan1990/agents_practtice

Update repository coding standards with Python formatting and docstring rules

开放

#8 创建于 2025年7月26日

 (1 条评论) (0 个反应) (0 位负责人)Python (0 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (0 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Description

We need to establish and document clear coding standards for Python code, particularly around formatting and docstrings, in our custom instructions file. This will ensure consistency across the codebase and make it easier for new contributors to maintain our code quality standards.

Why is this important?

  • Ensures consistent code quality across the project
  • Makes code review process more efficient
  • Improves code maintainability
  • Helps new contributors understand our coding expectations
  • Makes documentation more consistent and useful

Acceptance Criteria

  • Create or update Python-specific instructions file in .github/instructions/
  • Define clear rules for:
    • Code formatting (indentation, line length, etc.)
    • Import ordering
    • Docstring format and requirements
    • Type hints usage
    • Function and variable naming conventions
  • Include examples of correct and incorrect code formatting
  • Add guidelines for documentation comments
  • Update existing documentation to reference the new standards
  • Add information about recommended linting tools and configurations
  • Include instructions for running formatters and linters
  • Update CI/CD pipeline to enforce these standards if necessary

贡献者指南