Update pull_request_template.md #1909
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dguittet
requested review from
brtietz,
sjanzou,
janinefreeman,
cpaulgilman,
tyneises,
qualand,
mjprilliman and
taylorbrown75
brtietz
reviewed
Nov 13, 2024
| @@ -14,7 +14,8 @@ Please delete options that are not relevant. | |||
| - [ ] New feature (non-breaking change which adds functionality) | |||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | |||
| - [ ] This change requires a documentation update | |||
| - [ ] This change modifies variables in existing compute modules. Please see [Checking for PySAM Incompatible API Changes](https://github.com/NREL/SAM/wiki/Checking-for-PySAM-Incompatible-API-Changes). | |||
| - [ ] This change modifies variables in existing compute modules. Please see [Checking for PySAM Incompatible API Changes](https://github.com/NREL/SAM/wiki/PySAM-Incompatible-API-Changes-&-Regenerating-PySAM-Files). | |||
| - [ ] This change requires updating the PySAM files via export_config. Please see [When do the PySAM files need to be regenerated?](https://github.com/NREL/SAM/wiki/PySAM-Incompatible-API-Changes-&-Regenerating-PySAM-Files#when-do-the-pysam-files-need-to-be-regenerated-via-export_config) | |||
There was a problem hiding this comment.
Change to the template looks good.
I think the wiki page is correct but incomplete. Non breaking changes such as non-required variables or new outputs would also trigger a export_config run, but don't trigger a new major PySAM version.
There was a problem hiding this comment.
Thanks, I've added that
brtietz
approved these changes
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the Pull Request Template to add instructions for checking when export_config needs to be run
Adding everyone as reviewers as a notification :P