Skip to content

Commit 784d58a

Browse files
authored
Merge pull request #566 from NREL/pr-template
Add PR description template
2 parents e838ada + 8204b6e commit 784d58a

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Please check if the PR fulfills these requirements
2+
- [ ] CHANGELOG.md is updated
3+
- [ ] Docs have been added / updated if applicable
4+
- [ ] Any new packages have been added to the [compat] section of Project.toml
5+
- [ ] REopt version number is updated in Project.toml and CHANGELOG.md if merging into master (do this right before or right after merging)
6+
- [ ] 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).
7+
- [ ] Any new REopt outputs and required inputs have been added to the corresponding Django model in the REopt API
8+
9+
### Replace this with a description of the changes (can just copy from CHANGELOG.md)

docs/src/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,14 @@ ENV["NREL_DEVELOPER_EMAIL"]="your contact email"
2424
### Additional package loading for GHP
2525
GHP evaluations must load in the [`GhpGhx.jl`](https://github.com/NREL/GhpGhx.jl) package separately because it has a more [restrictive license](https://github.com/NREL/GhpGhx.jl/blob/main/LICENSE.md) and is not a registered Julia package.
2626

27-
First add the GhpGhx.jl package to the project's dependencies from the package manager (`]`):
27+
Install gcc via homebrew (if running on a Mac).
28+
29+
Add the GhpGhx.jl package to the project's dependencies from the package manager (`]`):
2830
```sh
2931
(active_env) pkg> add "https://github.com/NREL/GhpGhx.jl"
3032
```
3133

32-
Then load in the package from the script where `run_reopt()` is called:
34+
Load in the package from the script where `run_reopt()` is called:
3335
```julia
3436
using GhpGhx
35-
```
37+
```

0 commit comments

Comments
 (0)