Contribute

HyperSpy is a community project maintained for and by its users. There are many ways you can help!

• Help other users on gitter

• report a bug or request a feature on GitHub

• or improve the documentation and code

Contributing Guide

• Introduction
  • Who this guide is for
  • Getting started
  • 1. Start using HyperSpy and understand it
  • 2. Got a problem? – ask!
  • 3. Contribute – yes you can!
  • 4. Contributing code
• Using Git and GitHub
  • Use Git and work in manageable branches
  • Semantic versioning and HyperSpy main branches
  • Changing base branch
  • Keeping the git history clean
• Running and writing tests
  • Writing tests
  • Running tests
  • Flaky tests
  • Test coverage
  • Continuous integration (CI)
  • Plot testing
  • Exporting pytest results as HTML
• Writing documentation
  • Docstrings
  • User-guide documentation
  • Build the documentation
  • Hosting versioned documentation
• Coding style
• Pre-commit hooks
• Deprecations
• Traits conventions
  • Handler pattern
  • Plain classes (not HasTraits)
  • ROI validation/revert
  • List item observation
  • Deprecated patterns
• Tips for writing methods that work on lazy signals
• Interactive Plotting
• Speeding up code
  • Writing Numba code
  • Writing Cython code
• Writing packages that extend HyperSpy
  • Registering extensions
  • Creating new HyperSpy BaseSignal subclasses
  • Creating new HyperSpy model components
  • Creating and registering new widgets and toolkeys
  • Integration test suite
• Lazy import
• Useful information
  • NEP 29 — Recommend Python and Numpy version support
  • Conda-forge packaging
  • Monitoring version distribution
  • HTML Representations
• Coding with AI assistants
  • The effort asymmetry
  • What counts as AI-assisted development
  • Disclosing AI assistance
  • Installing the tools and learning the workflow
  • Your AI-assisted learning path: learning to verify AI output
  • Choosing a project
  • Building skills for the long term
  • Getting your pull requests accepted: what makes a review light
  • AGENTS.md files
  • For reviewers
• Maintenance
  • GitHub Workflows
  • Updating GitHub Actions