Skip to content

Update notebook contributing guidelines#353

Open
RDaxini wants to merge 2 commits into
developmentfrom
contributing_notebooks
Open

Update notebook contributing guidelines#353
RDaxini wants to merge 2 commits into
developmentfrom
contributing_notebooks

Conversation

@RDaxini

@RDaxini RDaxini commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Describe your changes

See linked issue

Issue ticket number and link

Fixes #352

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code
  • Code changes are covered by tests.
  • Code changes have been evaluated for compatibility/integration with Scenario analysis (for future PRs)
  • Code changes have been evaluated for compatibility/integration with geospatial autotemplating (for future PRs)
  • New functions added to init.py
  • API.rst is up to date, along with other sphinx docs pages
  • Example notebooks are rerun and differences in results scrutinized
  • What's new changelog has been updated in the docs

@RDaxini RDaxini changed the base branch from main to development July 13, 2026 20:25
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.72%. Comparing base (5b76b1a) to head (0bc851b).
⚠️ Report is 48 commits behind head on development.

Additional details and impacted files
@@             Coverage Diff              @@
##           development     #353   +/-   ##
============================================
  Coverage        74.72%   74.72%           
============================================
  Files               41       41           
  Lines             4823     4823           
============================================
  Hits              3604     3604           
  Misses            1219     1219           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the project’s documentation to correct guidance for contributing Jupyter notebooks, aligning it with the repository’s CI notebook validation approach (nbval) and the expectation that tutorial notebooks are committed with executed outputs.

Changes:

  • Update contributing guidelines to instruct contributors to execute notebooks and commit outputs (instead of clearing them).
  • Add explicit jupyter nbconvert --to notebook --execute --inplace instructions and guidance for handling non-reproducible outputs (via # NBVAL_IGNORE_OUTPUT).
  • Add a release note entry documenting the contributing-guideline correction.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/source/whatsnew/releases/v0.7.2.rst Adds a release note documenting the corrected notebook contribution guidance and CI expectations.
docs/source/user_guide/contributing.rst Updates notebook contribution instructions to commit executed outputs and provides rerun/nbval guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/user_guide/contributing.rst
@RDaxini RDaxini requested a review from martin-springer July 14, 2026 15:48
@RDaxini RDaxini added this to the v0.7.2 milestone Jul 14, 2026
@RDaxini RDaxini added documentation Improvements or additions to documentation Clarity for users Things that help the user implement the code more easily. labels Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Clarity for users Things that help the user implement the code more easily. documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect contributing guidelines regarding notebook contributions

3 participants