Skip to content

Update pull_request_template.md - #26

Merged
VCUclse405 merged 3 commits into
mainfrom
kbhalajiyadav-patch-1
May 21, 2026
Merged

Update pull_request_template.md#26
VCUclse405 merged 3 commits into
mainfrom
kbhalajiyadav-patch-1

Conversation

@kbhalajiyadav

@kbhalajiyadav kbhalajiyadav commented May 21, 2026

Copy link
Copy Markdown
Member

Add notebook integrity check workflow

Summary

This pull request adds a lightweight GitHub Actions workflow that validates the root-level Jupyter notebook structure whenever a notebook is changed in a pull request or pushed to main.

Type of change

  • Documentation update
  • Bug fix
  • New analysis feature
  • Workflow or notebook update
  • Dependency/environment update
  • Figure/table/output update
  • Repository maintenance
  • Other

What changed?

  • Added .github/workflows/notebook-check.yml.
  • The workflow checks that root-level .ipynb files can be parsed as JSON.
  • The workflow verifies that each notebook has a cells field and that each cell has cell_type and source.

Why is this change needed?

Direct notebook editing can easily introduce JSON errors, missing commas, or corrupted cell structure. This check provides a basic automated safeguard before merging notebook changes into main.

Reproducibility impact

  • Input data
  • Data preprocessing
  • Analysis settings
  • Metric definitions
  • Output files
  • Figures or tables
  • Dependency versions
  • Release or DOI documentation
  • No reproducibility impact

Explanation:

This adds repository-level validation only. It does not change the notebook analysis logic, manuscript-baseline settings, metric definitions, dependencies, or outputs.

Testing / verification

  • Added a GitHub Actions workflow for notebook JSON validation.
  • Workflow is expected to run on pull requests that modify .ipynb files or the workflow file itself.
  • Confirmed the check passes on GitHub.

Manuscript or public-release relevance

  • Affects manuscript/public-release results
  • Does not affect manuscript/public-release results
  • Not applicable

Explanation:

This PR adds an automated repository check only. It does not affect submitted, archived, or manuscript-baseline numerical results.

Checklist

  • The change is focused and described clearly.
  • README or documentation was updated if needed.
  • CHANGELOG was updated if appropriate.
  • Dependency files were updated if needed.
  • Generated or temporary files were not accidentally committed.
  • Large or sensitive data were not committed without approval.

@kbhalajiyadav
kbhalajiyadav requested a review from a team as a code owner May 21, 2026 23:02
@VCUclse405
VCUclse405 merged commit 661cf5c into main May 21, 2026
2 checks passed
@VCUclse405
VCUclse405 deleted the kbhalajiyadav-patch-1 branch May 21, 2026 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants