Skip to content

Conversation

@jeipollack
Copy link
Contributor

@jeipollack jeipollack commented Dec 17, 2025

Summary

This pull request updates the pull_request_template.md template to reflect current workflow and CI tooling.

Closes #191

What’s changed

  • Removed obsolete Black formatting checklist item (CI now uses ruff)
  • Updated Validation section to reference the issue instead of pasting logs in the PR
  • Reorganized headers and checklist for clarity and consistency with CONTRIBUTING.md and DEV_WORKFLOW.md
  • Added sections for PR type, scope, and next steps
  • Minor changes (add single-line space and delete leftover ---) to configuration.md

How to test / verify

  • Review the updated pull_request_template.md for clarity and readability
  • Confirm Black-related references are removed and ruff guidance is correct
  • Confirm validation instructions point to the issue, not the PR
  • Verify consistency with DEV_WORKFLOW.md and CONTRIBUTING.md

Scope

  • Documentation / process change
  • Feature
  • Bug fix
  • Hotfix
  • Internal / refactor

Changelog

  • Changelog fragment added (not applicable; documentation change only)

Reviewer Checklist

  • PR targets develop branch
  • PR is assigned to the developer
  • Appropriate labels applied
  • PR included in relevant projects/milestones
  • Description clearly explains what has changed
  • Issue references included (#<ISSUE_NUMBER>)
  • Code and documentation adhere to current standards
  • Documentation updates included, if relevant
  • CI tests are passing
  • All reviewer comments have been addressed

Next Steps / Notes

No follow-up actions required. This PR updates the template only.

@jeipollack jeipollack self-assigned this Dec 17, 2025
@jeipollack jeipollack added the documentation Improvements or additions to documentation label Dec 17, 2025
@jeipollack jeipollack force-pushed the docs/191/update-pull-request-template branch from 23c349d to a3f69af Compare December 17, 2025 15:52
Jennifer Pollack added 8 commits January 9, 2026 16:46
…ean up submodule docs, update conf.py, and update pyproject.toml version
- Removed old auto-generated wf_psf.rst from _autosummary
- Updated toc.rst (fixed tab issues, reference api.rst)
- Added api.rst with :recursive: directive and wf_psf.run entrypoint
- Refined __init__.py docstrings for all subpackages for clarity and consistency
- Updated module-level docstrings (purpose, authors, TensorFlow notes, etc.)
- Shorten sections to make developer-friendly
- Added new structure for each section: Purppose, Key Fields, Notes, General Notes, etc, where applicable
- Partial completion - new PR is required to verify optional versus required settings
- Added cross-references between config sections
- Clarified required fields for ground_truth_model.model_params
- Updated General Notes and reorganized section numbering
- Improved examples and directory structures
- Fixed build warnings due to missing anchors and code block lexing
@jeipollack jeipollack force-pushed the docs/191/update-pull-request-template branch from a3f69af to 3c46b43 Compare January 9, 2026 16:05
@ChaitanyaChawak ChaitanyaChawak merged commit 2679f58 into develop Jan 15, 2026
2 checks passed
@ChaitanyaChawak ChaitanyaChawak deleted the docs/191/update-pull-request-template branch January 15, 2026 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

3 participants