Skip to content
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.

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

[1pt] PR: Update PR template #856

Merged
merged 9 commits into from
Mar 31, 2023
Merged

[1pt] PR: Update PR template #856

merged 9 commits into from
Mar 31, 2023

Conversation

robgpita
Copy link
Contributor

@robgpita robgpita commented Mar 21, 2023

Simple update to the PULL_REQUEST_TEMPLATE.md to remove unnecessary/outdated boilerplate items, add octothorpe (#) in front of Additions, Changes, Removals to mirror CHANGELOG.md format, and clean up the PR Checklist.

Changes

  • docs/
    • PULL_REQUEST_TEMPLATE.md - Update template to match CHANGELOG formatting, improve checklist to be applicable

Testing

n/a

Checklist

You may update this checklist before and/or after creating the PR. If you're unsure about any of them, please ask, we're here to help! These items are what we are going to look for before merging your code.

  • Informative and human-readable title, using the format: [_pt] PR: <description>
  • Links are provided if this PR resolves an issue, or depends on another other PR
  • If submitting a PR to the dev branch (the default branch), you have a descriptive Feature Branch name using the format: dev-<description-of-change> (ie: dev-revise-levee-masking)
  • Changes are limited to a single goal (no scope creep)
  • The feature branch you're submitting as a PR is up to date (merged) with the latest dev branch
  • Changes adhere to PEP-8 Style Guidelines
  • Any change in functionality is tested
  • Passes all unit tests locally (inside interactive Docker container, at /foss_fim/, run: pytest unit_tests/)
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (CHANGELOG and/or README)
  • Reviewers requested

@CarsonPruitt-NOAA CarsonPruitt-NOAA added the documentation Improvements or additions to documentation label Mar 22, 2023
Copy link
Contributor

@mluck mluck left a comment

Choose a reason for hiding this comment

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

I left a few very minor comments -- consider them optional suggestions.

Thanks for revising this!

@BradfordBates-NOAA BradfordBates-NOAA changed the title [1 pt] Update PR template [1pt] Update PR template Mar 24, 2023
@robgpita
Copy link
Contributor Author

@mluck thanks for your review and suggestions. I appreciate it. I addressed each one. Please let me know if you'd like to see modifications to the checklist, after the updates I made.

@robgpita robgpita requested a review from mluck March 24, 2023 21:33
mluck
mluck previously approved these changes Mar 28, 2023
Copy link
Contributor

@mluck mluck left a comment

Choose a reason for hiding this comment

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

Looks good! The only other thing to change would be to add "PR: " to the title.

@BradfordBates-NOAA
Copy link
Member

Thanks, Rob. Nice work. This is a big improvement WRT standardizing our process.

I agree with Matt's comment about adding "PR:" to title of this Pull Request.

@robgpita robgpita changed the title [1pt] Update PR template [1pt] PR: Update PR template Mar 28, 2023
@BradfordBates-NOAA
Copy link
Member

Looks like there are unresolved conflicts in the Changelog

@CarsonPruitt-NOAA CarsonPruitt-NOAA merged commit 3236547 into dev Mar 31, 2023
@CarsonPruitt-NOAA CarsonPruitt-NOAA deleted the dev-pr-template branch March 31, 2023 16:37
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants