Add PR description template #566
Merged
Conversation
This file contains hidden or 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
ElectricTariff results documentation corrections [v0.56.3]
4 patches
add note to install gcc via homebrew to the REopt documentation page that explains how to do GHP runs
adfarth
reviewed
Jan 5, 2026
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - [ ] Any new packages have been added to the [compat] section of Project.toml | ||
| - [ ] REopt version number is updated in Project.toml and CHANGELOG.md if merging into master (do this right before or right after merging) | ||
| - [ ] Tests for the changes have been added. These tests should compare against expected values that are calculated independently of running REopt. Tests should also include garbage collection (see other tests for examples). | ||
| - [ ] Any new REopt outputs have been added to the corresponding Django model in the REopt API |
Collaborator
There was a problem hiding this comment.
suggest: inputs, outputs, or endpoints
Collaborator
Author
There was a problem hiding this comment.
I added "required inputs", but inputs with defaults don't need to be added to the API. It's just the outputs that will cause django errors if they aren't added.
Collaborator
Author
Yeah it is that. This PR doesn't change any of the actual REopt code so I'm not worried about tests. |
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.
No description provided.