Skip to content

Conversation

@brownbaerchen
Copy link
Collaborator

Due Diligence

  • General:
  • Implementation:
    • unit tests: all split configurations tested
    • unit tests: multiple dtypes tested
    • NEW unit tests: MPS tested (1 MPI process, 1 GPU)
    • benchmarks: created for new functionality
    • benchmarks: performance improved or maintained
    • documentation updated where needed

Description

Small update to the contributing guide. Next to one small typo fix, the only change I propose is to recommend installing the code in editable mode with pip install -e. This way, edits to the code actually show up in the locally installed version. This is the simplest way that I know of that achieves this.

Changes proposed:

  • Recommend installing in editable mode
  • fix typo

Type of change

Documentation update

@brownbaerchen brownbaerchen added documentation Anything related to documentation HeatHub The HeatHub project, as part of Science Serve, aims to foster the Heat community. labels Jan 5, 2026
Copy link
Contributor

@ClaudiaComito ClaudiaComito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @brownbaerchen !

@ClaudiaComito ClaudiaComito added this to the 1.7.1 milestone Jan 14, 2026
@github-project-automation github-project-automation bot moved this to Todo in Roadmap Jan 14, 2026
@github-project-automation github-project-automation bot moved this from Todo to Merge queue in Roadmap Jan 14, 2026
@ClaudiaComito ClaudiaComito modified the milestones: 1.7.1, 1.8.0 Jan 14, 2026
@brownbaerchen brownbaerchen merged commit f306c6a into helmholtz-analytics:main Jan 14, 2026
6 checks passed
@github-project-automation github-project-automation bot moved this from Merge queue to Done in Roadmap Jan 14, 2026
@brownbaerchen brownbaerchen deleted the update_contributing_guide branch January 14, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything related to documentation HeatHub The HeatHub project, as part of Science Serve, aims to foster the Heat community.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants