Skip to content

Overhaul project structure, developer workflow, and documentation#142

Open
sansiro77 wants to merge 23 commits intoTuringQ:mainfrom
sansiro77:dev-docs
Open

Overhaul project structure, developer workflow, and documentation#142
sansiro77 wants to merge 23 commits intoTuringQ:mainfrom
sansiro77:dev-docs

Conversation

@sansiro77
Copy link
Contributor

@sansiro77 sansiro77 commented Feb 12, 2026

Summary

This PR introduces a major overhaul of the project's development infrastructure. We have migrated our linting and formatting stack to Ruff, integrated Jupytext for better notebook version control, and established a mandatory pre-commit workflow to ensure long-term code quality and consistency.

Key Changes

1. Breaking Changes

  • Class Rename: In the Photonic module, the class GBS_Graph has been renamed to GraphGBS.

2. Tooling & Infrastructure

  • Integrated Ruff: Replaced Pylint with Ruff for lightning-fast linting and formatting.
  • Jupytext Integration: Established paired .ipynb and .py:percent files for tutorials and examples to allow cleaner git diffs.
  • Pre-commit Hooks: Added .pre-commit-config.yaml to automate:
    • Code linting and formatting (Ruff).
    • Notebook synchronization (Jupytext).
    • General file sanity checks (trailing whitespace, EOF).

3. Documentation & Standards

  • CONTRIBUTING.md: Created a comprehensive guide for new contributors.
  • README.md: Updated with modern developer setup instructions and badges.
  • Docstring Standard: Enforced Google-style docstrings in the src/ directory via ruff.toml.
  • Tutorials Overhaul: Reorganized file paths and updated titles for better navigation.

@sansiro77 sansiro77 added documentation Improvements or additions to documentation workflow Improvements to developer workflow, project infrastructure, and automation tools. labels Feb 12, 2026
@sansiro77 sansiro77 changed the title Refactor via Ruff Overhaul project structure, developer workflow, and documentation Feb 13, 2026
@sansiro77 sansiro77 self-assigned this Feb 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation workflow Improvements to developer workflow, project infrastructure, and automation tools.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments