Skip to content

Incorrect contributing guidelines regarding notebook contributions #352

Description

@RDaxini

Describe the bug
Guidelines advise users to clear outputs before committing changes to notebooks

To Reproduce
See

* Clear outputs before committing (pre-commit will help)

Expected behavior
Outputs should not be cleared. Notebooks should be rerun to store new outputs if core logic has changed.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • pvdeg version [e.g. 22]

Additional context
Might be helpful to add a note on how to rerun using jupyter nbconvert (for example jupyter nbconvert --to notebook --execute --inplace tutorials/04_scenario/01_scenario_temperature.ipynb

Metadata

Metadata

Assignees

No one assigned

    Labels

    Clarity for usersThings that help the user implement the code more easily.documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions