Skip to content

Conversation

@JasonGlazer
Copy link
Contributor

Pull request overview

  • Since this epJSON Editor is on a different repo, this is primarily for the review of the associated new feature proposal.

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@JasonGlazer JasonGlazer added NewFeature Includes code to add a new feature to EnergyPlus AuxiliaryTool Related to an auxiliary tool, not EnergyPlus itself (readvars, preprocessor, ep-launch, etc.) labels Dec 20, 2024
@JasonGlazer JasonGlazer added this to the EnergyPlus 25.1 milestone Dec 20, 2024
@JasonGlazer JasonGlazer self-assigned this Dec 20, 2024
@JasonGlazer JasonGlazer marked this pull request as draft December 20, 2024 19:24
@JasonGlazer JasonGlazer marked this pull request as ready for review January 8, 2025 19:36
@JasonGlazer
Copy link
Contributor Author

JasonGlazer commented Jan 8, 2025

The NFP was discussed on today's technical call with only a question from @jasondegraw. Since the work is in a different repo, I expect that the NFP, which includes an "approach" section for the design document, should probably be merged or else we can wait to merge it until after the work is complete.

If anyone has any additional questions or comments, please let me know.

@Myoldmopar
Copy link
Member

Normally I'd say let's let the PR stay around, but the PR list is huge and this is an easy quick merge. Thanks for providing this and discussing it. Merging.

@Myoldmopar Myoldmopar merged commit 61aaa70 into develop Jan 9, 2025
@Myoldmopar Myoldmopar deleted the epJSONEd-NFP branch January 9, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AuxiliaryTool Related to an auxiliary tool, not EnergyPlus itself (readvars, preprocessor, ep-launch, etc.) NewFeature Includes code to add a new feature to EnergyPlus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants