× ⚠️ You are reading the development version documentation.
Read here the documentation of the last stable release.

Developer’s Guide

This guide is for contributors working on SpectroChemPy code, documentation, tests, or official plugins.

Note

A large part of the content/structure of this guide has been copied and adapted from the Pandas developer guide.

Start with Contributing to SpectroChemPy for the development setup and pull request workflow. Use Contributing to the code for testing, formatting, deprecations, and changelog entries. Plugin-specific architecture and packaging guidance lives under Plugin developer guide.

Maintainer-only operational procedures are documented separately in the repository and are intentionally kept outside this published guide.

• Contributing to SpectroChemPy
  • General Principles
  • Getting Started with Development
  • Maintainer and Release Notes
• Contributing to the code
  • Code standards
  • Pre-commit
  • Optional dependencies
  • Testing with continuous integration
  • Test-driven development/code writing
  • Running the test suite
  • Test state guards
  • Documenting change log
• Contributing to specific parts of the code
  • Adding a Reader
• Contributing to Documentation
  • Documentation Structure
  • Documentation Sources
  • Building Documentation
  • Writing Tips
• Plotting Contributions
  • Scope
  • Core Rules
  • Lazy Matplotlib
  • Preferences and Styles
  • What to Avoid
  • Testing Guidance
  • When to Go Deeper
  • Checklist
• Plotting Architecture
  • Motivation
  • Current Architecture
  • Responsibility Boundaries
  • Design Principles
  • Architecture Rules
  • What Was Intentionally Not Centralized
  • Figure and Axes Lifecycle
  • Practical Contributor Guidance
  • Future Evolution
• Plugin developer guide
  • Plugin author guide
  • Plugin architecture
  • Plugin accessors
  • Numeric backends
  • Unit contexts
  • Packaging a Plugin
  • Testing a Plugin
  • Plugin API Policy
  • Official plugin architecture notes
  • Plugin architecture map