8000 [docs] add new steps to pull request checklist as change fragment types by zacharyburnett · Pull Request #8824 · spacetelescope/jwst · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[docs] add new steps to pull request checklist as change fragment types #8824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Sep 24, 2024
Merged

[docs] add new steps to pull request checklist as change fragment types #8824

merged 2 commits into from
Sep 24, 2024

Conversation

zacharyburnett
Copy link
Collaborator
@zacharyburnett zacharyburnett commented Sep 23, 2024 •
edited
Loading

adds new change fragment types pipeline, clean_flicker_noise, and badpix_selfcal to the pull request checklist (they're already in pyproject.toml)

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types... 
- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
- ``changes/<PR#>.docs.rst``
- ``changes/<PR#>.stpipe.rst``
- ``changes/<PR#>.datamodels.rst``
- ``changes/<PR#>.scripts.rst``
- ``changes/<PR#>.fits_generator.rst``
- ``changes/<PR#>.set_telescope_pointing.rst``

## stage 1
- ``changes/<PR#>.group_scale.rst``
- ``changes/<PR#>.dq_init.rst``
- ``changes/<PR#>.emicorr.rst``
- ``changes/<PR#>.saturation.rst``
- ``changes/<PR#>.ipc.rst``
- ``changes/<PR#>.firstframe.rst``
- ``changes/<PR#>.lastframe.rst``
- ``changes/<PR#>.reset.rst``
- ``changes/<PR#>.superbias.rst``
- ``changes/<PR#>.refpix.rst``
- ``changes/<PR#>.linearity.rst``
- ``changes/<PR#>.rscd.rst``
- ``changes/<PR#>.persistence.rst``
- ``changes/<PR#>.dark_current.rst``
- ``changes/<PR#>.charge_migration.rst``
- ``changes/<PR#>.jump.rst``
- ``changes/<PR#>.ramp_fitting.rst``
- ``changes/<PR#>.gain_scale.rst``

## stage 2
- ``changes/<PR#>.assign_wcs.rst``
- ``changes/<PR#>.msaflagopen.rst``
- ``changes/<PR#>.nsclean.rst``
- ``changes/<PR#>.imprint.rst``
- ``changes/<PR#>.background.rst``
- ``changes/<PR#>.extract_2d.rst``
- ``changes/<PR#>.master_background.rst``
- ``changes/<PR#>.wavecorr.rst``
- ``changes/<PR#>.srctype.rst``
- ``changes/<PR#>.straylight.rst``
- ``changes/<PR#>.wfss_contam.rst``
- ``changes/<PR#>.flatfield.rst``
- ``changes/<PR#>.fringe.rst``
- ``changes/<PR#>.pathloss.rst``
- ``changes/<PR#>.barshadow.rst``
- ``changes/<PR#>.photom.rst``
- ``changes/<PR#>.pixel_replace.rst``
- ``changes/<PR#>.resample_spec.rst``
- ``changes/<PR#>.residual_fringe.rst``
- ``changes/<PR#>.cube_build.rst``
- ``changes/<PR#>.extract_1d.rst``
- ``changes/<PR#>.resample.rst``

## stage 3
- ``changes/<PR#>.assign_mtwcs.rst``
- ``changes/<PR#>.mrs_imatch.rst``
- ``changes/<PR#>.tweakreg.rst``
- ``changes/<PR#>.skymatch.rst``
- ``changes/<PR#>.exp_to_source.rst``
- ``changes/<PR#>.outlier_detection.rst``
- ``changes/<PR#>.tso_photometry.rst``
- ``changes/<PR#>.stack_refs.rst``
- ``changes/<PR#>.align_refs.rst``
- ``changes/<PR#>.klip.rst``
- ``changes/<PR#>.spectral_leak.rst``
- ``changes/<PR#>.source_catalog.rst``
- ``changes/<PR#>.combine_1d.rst``
- ``changes/<PR#>.ami.rst``

## other
- ``changes/<PR#>.wfs_combine.rst``
- ``changes/<PR#>.white_light.rst``
- ``changes/<PR#>.cube_skymatch.rst``
- ``changes/<PR#>.engdb_tools.rst``
- ``changes/<PR#>.guider_cds.rst``

@zacharyburnett zacharyburnett added this to the Build 11.2 milestone Sep 23, 2024
@zacharyburnett zacharyburnett requested a review from a team as a code owner September 23, 2024 18:08
@github-actions github-actions bot added the automation Continuous Integration (CI) and testing automation tools label Sep 23, 2024
@zacharyburnett zacharyburnett changed the title add new steps to pull request checklist [docs] add new steps to pull request checklist as change fragment types Sep 23, 2024
tapastro
tapastro approved these changes Sep 23, 2024
View reviewed changes
Copy link
Contributor
@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

Looks fine to me. Presumably the indentation change doesn't affect display?

@zacharyburnett
Copy link
Collaborator Author

Looks fine to me. Presumably the indentation change doesn't affect display?

the indented lines were put into a code block instead of a bulleted list, so this fixes that

@zacharyburnett zacharyburnett merged commit 56328cf into spacetelescope:main Sep 24, 2024
28 checks passed
@zacharyburnett zacharyburnett deleted the pr_checklist/new_steps branch September 24, 2024 13:01
hayescr pushed a commit to hayescr/jwst that referenced this pull request Oct 29, 2024
@zacharyburnett @hayescr
[docs] add new steps to pull request checklist as change fragment typ…
41b154e 
…es (spacetelescope#8824)
@codecov Codecov
Copy link
codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.86%. Comparing base (947d48b) to head (e0999e5).
Report is 446 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #8824   +/-   ##
=======================================
  Coverage   61.86%   61.86%           
=======================================
  Files         377      377           
  Lines       38911    38911           
=======================================
  Hits        24071    24071           
  Misses      14840    14840

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5DE2
Reviewers

@tapastro tapastro tapastro approved these changes

Assignees
No one assigned
Labels
automation Continuous Integration (CI) and testing automation tools no-changelog-entry-needed
Projects
None yet
Milestone
Build 11.2
Development

Successfully merging this pull request may close these issues.
2 participants
@zacharyburnett @tapastro
0