Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Default owners for everything in this repository.
* @ppinchuk
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Bug Report
description: Notify the developers of anomalous or incorrect reVeal behavior
type: Bug

body:
- type: checkboxes
id: checks
attributes:
label: reVeal version checks
options:
- label: >
I have confirmed this bug has not already been reported.
required: true
- label: >
I have confirmed this bug exists on the
[latest version](https://github.com/NREL/reVeal/releases/latest) of reVeal.
required: true
- label: >
I have confirmed this bug exists on the main branch of reVeal.
- type: textarea
id: problem
attributes:
label: Bug Description
description: >
Please provide a clear and concise description of the issue/bug. If applicable, add screenshots to help explain your problem.
validations:
required: true
- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pastable example.
placeholder: >
$ reVeal characterize -c config.json5
...
validations:
required: true
- type: textarea
id: traceback
attributes:
label: Full Traceback
description: >
Please provide a *full* traceback of any errors received, if applicable.
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: textarea
id: version
attributes:
label: System and installed versions
description: >
Please provide all applicable system and library versions.
value: |
- OS: [e.g. OSX, Windows, Linux]
- Compute hardware: [e.g. Kestrel, AWS]
- reVeal Version: [e.g. 0.12.1]
- Python Version: [e.g. 3.13]
- GeoPandas Version: [e.g. 2.1.0]
...

validations:
required: true
- type: input
id: charge-code
attributes:
label: Charge code
options:
- label: >
I am at NLR and am willing to provide a charge code to have this bug fixed urgently.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://github.com/NREL/reV/discussions
about: |
Ask questions about the reV suite (including reVeal) and discuss with the developers and
other users here. If you have a question like "How do I calculate site-suitability scores?", please
include a self-contained reproducible example of what you have tried already, if possible.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Documentation Improvement
description: Report wrong, missing, or incomplete reVeal documentation
type: Task
labels: [documentation, enhancement]

body:
- type: checkboxes
attributes:
label: reVeal version checks
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `main` [here](https://nrel.github.io/reVeal/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation, e.g. ``reVeal.maps.map_geodataframe_column`` or the
URL of the documentation, e.g.
"https://nrel.github.io/reVeal/_autosummary/reVeal.maps.html#reVeal.maps.map_geodataframe_column"
placeholder: https://nrel.github.io/reVeal/_autosummary/reVeal.maps.html#reVeal.maps.map_geodataframe_column
validations:
required: true
- type: textarea
id: problem
attributes:
label: Documentation problem
description: >
Please provide a description of what documentation you believe needs to be fixed/improved.
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested fix for documentation
description: >
Please provide a suggested fix for the wrong, missing, or incomplete documentation.
validations:
required: true
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Feature Request
description: Request a new reVeal feature
type: Feature

body:
- type: checkboxes
id: checks
attributes:
label: Feature Type
description: Please check what type of feature request you would like to propose.
options:
- label: >
Adding new functionality to reVeal
- label: >
Changing existing functionality in reVeal
- label: >
Removing existing functionality in reVeal
- type: textarea
id: description
attributes:
label: Problem Description
description: >
Is your feature request related to a problem? Please describe.
placeholder: |
I'm always frustrated when [...]
I wish I could use reVeal to [...]

validations:
required: true
- type: textarea
id: feature
attributes:
label: Feature Description
description: >
Please provide a clear and concise description of the feature (i.e. what you want to happen).
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternative Solutions
description: >
Please describe any alternative solution (existing functionality, 3rd party package, etc.)
that you've considered.
placeholder: |
```python
# Your code here, if applicable

```
- type: textarea
id: context
attributes:
label: Additional Context
description: >
Please provide any relevant GitHub issues, code examples, references, screenshots, or other material
that help describe and support the feature request.
- type: input
id: charge-code
attributes:
label: Charge code
options:
- label: >
I am at NLR and am willing to provide a charge code to have this feature added urgently.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/installation_issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Installation Issue
description: Report issues installing reVeal on your system

body:
- type: checkboxes
id: checks
attributes:
label: Installation check
options:
- label: >
I have read the [installation guide](https://nrel.github.io/reVeal/misc/installation.html).
required: true
- type: input
id: platform
attributes:
label: Platform
description: >
Please provide the output of ``import platform; print(platform.platform())``
validations:
required: true
- type: dropdown
id: method
attributes:
label: Installation Method
description: >
Please provide how you tried to install reVeal from a clean environment.
options:
- pip install (from PyPi)
- pip install . (from source)
- Other
validations:
required: true
- type: input
id: reVeal
attributes:
label: reVeal Version
description: >
Please provide the version of reVeal you are trying to install.
validations:
required: true
- type: input
id: python
attributes:
label: Python Version
description: >
Please provide the installed version of Python.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Installation Logs
description: >
If possible, please copy and paste the installation logs when attempting to install reVeal.
value: >
Replace this line with the installation logs
9 changes: 9 additions & 0 deletions .github/codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
coverage:
status:
project:
default:
target: auto
threshold: 1%
patch:
default:
target: 80%
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
updates:

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: weekly
day: monday
open-pull-requests-limit: 10
labels:
- "chore"
- "dependencies"
- "github-actions"
50 changes: 50 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name-template: 'Draft: v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
categories:
- title: 'Breaking Changes'
labels:
- 'breaking'
- title: 'Features'
labels:
- 'feature'
- 'enhancement'
- 'new computation'
- title: 'Bug Fixes'
labels:
- 'fix'
- 'bug'
- 'bugfix'
- title: 'Updates'
labels:
- 'refactor'
- 'documentation'
- title: 'Chores'
labels:
- 'dependencies'
- 'chore'
- 'github_actions'
version-resolver:
major:
labels:
- 'breaking'
minor:
labels:
- 'feature'
- 'enhancement'
- 'new computation'
patch:
labels:
- 'fix'
- 'bug'
- 'bugfix'
- 'refactor'
- 'documentation'
- 'dependencies'
- 'chore'
- 'github_actions'
default: patch
template: |
# What's Changed

$CHANGES
50 changes: 0 additions & 50 deletions .github/workflows/build_docs.yml

This file was deleted.

Loading