Skip to content

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Sep 7, 2025


Description

This pull request introduces significant updates to the contributor documentation:

  • Adds a Python Development Guide, detailing:
    • Compliance with PEP 8 standards.
    • Internationalization with gettext.
    • Code style conventions, logging, exception handling, GTK3 integration, and type hints.
    • Setup instructions for PyLint, pre-commit hooks, and recommended tools (e.g., PyCharm).
  • Refines existing contributor guides:
    • Simplifies the "Development Setup" guide and reduces redundancy.
    • Links essential prerequisites for contributors.
    • Reorganizes sections for improved readability and navigation.
    • Provides step-by-step instructions for configuring the documentation environment.

These updates aim to ensure smoother onboarding and standardized contributions.

- Introduced a comprehensive Python coding standards guide for contributors.
- Covers PEP 8 compliance, internationalization with gettext, and code style conventions.
- Includes guidelines for exception handling, logging, GTK3 integration, and type hints.
- Provides setup instructions for PyLint, pre-commit hooks, and recommended tools like PyCharm.
@ericbsd ericbsd requested review from a team as code owners September 7, 2025 01:17
@ericbsd ericbsd merged commit b4c90df into master Sep 7, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Sep 7, 2025
@ericbsd ericbsd deleted the improve-dev-docs branch September 7, 2025 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant