Skip to content

Commit

Permalink
Merge pull request #132 from e10harvey/add_templates
Browse files Browse the repository at this point in the history
Add initial templates
  • Loading branch information
e10harvey authored Sep 24, 2024
2 parents fe04d53 + 4f0b0b2 commit b58f65b
Show file tree
Hide file tree
Showing 6 changed files with 295 additions and 0 deletions.
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/code-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Code Bug Report
description: File a code bug report.
title: "[Code Bug]: "
labels: ["code bug", "triage"]
assignees:
- e10harvey, bbean23, braden6521
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
placeholder: develop@c481fdc
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What OS are you seeing this on?
multiple: true
options:
- Windows
- Linux
- MacOS
- type: textarea
id: dependencies
attributes:
label: Relevant dependency versions
description: Please copy and paste any relevant dependency versions (hint python3 --version, ffmpeg -version, pip list). This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: reproducer
attributes:
label: python script that produces the error
description: Please copy and paste the code that produces the error. This will be automatically formatted into code, so no need for backticks.
render: python
- type: textarea
id: logs
attributes:
label: Relevant console output
description: Please copy and paste any relevant console output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: contribution-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [contribution guidelines](https://github.com/sandialabs/OpenCSP/blob/main/CONTRIBUTING.md).
options:
- label: I agree to follow this project's contribution guidelines
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/code-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Code Feature Request
description: Request a new code feature.
title: "[Code Feature]: "
labels: ["code feature", "under review"]
assignees:
- e10harvey, bbean23, braden6521
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: feature-description
attributes:
label: Feature
description: Also, describe the feature you would like.
placeholder: Describe what you want!
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Feature
description: Also tell us, what are your requirements?
placeholder: As a X, I need to Y, so that I can Z.
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What OS do you intend to use this on?
multiple: true
options:
- Windows
- Linux
- MacOS
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: Also tell us, what third party dependencies does this feature require?
placeholder: foobar v1000
validations:
required: false
- type: checkboxes
id: contribution-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [contribution guidelines](https://github.com/sandialabs/OpenCSP/blob/main/CONTRIBUTING.md).
options:
- label: I agree to follow this project's contribution guidelines
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

contact_links:
- name: OpenCSP Community Support
url: https://github.com/sandialabs/OpenCSP/discussions
about: Please ask and answer questions here.
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/data-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Data Bug Report
description: File a data bug report.
title: "[Data Bug]: "
labels: ["data bug", "triage"]
assignees:
- e10harvey, bbean23, braden6521
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
placeholder: develop@c481fdc
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What OS are you seeing this on?
multiple: true
options:
- Windows
- Linux
- MacOS
- type: input
id: data-link
attributes:
label: Data link
description: How can we access the data you're having trouble with?
placeholder: ex. https://github.com/sandialabs/OpenCSP/tree/develop/opencsp/app/sofast/test/data/input/SofastConfiguration
validations:
required: true
- type: textarea
id: dependencies
attributes:
label: Relevant dependency versions
description: Please copy and paste any relevant dependency versions (hint python3 --version, ffmpeg -version, pip list). This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: reproducer
attributes:
label: python script that produces the error
description: Please copy and paste the code that produces the error. This will be automatically formatted into code, so no need for backticks.
render: python
- type: textarea
id: logs
attributes:
label: Relevant console output
description: Please copy and paste any relevant console output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: contribution-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [contribution guidelines](https://github.com/sandialabs/OpenCSP/blob/main/CONTRIBUTING.md).
options:
- label: I agree to follow this project's contribution guidelines
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/data-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Data Feature Request
description: Request a new data feature.
title: "[Data Feature]: "
labels: ["data feature", "under review"]
assignees:
- e10harvey, bbean23, braden6521
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: feature-description
attributes:
label: Feature
description: Also, describe the feature you would like.
placeholder: Describe what you want!
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
description: Also tell us, what are your requirements?
placeholder: As a X, I need to Y, so that I can Z.
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What OS do you intend to use this on?
multiple: true
options:
- Windows
- Linux
- MacOS
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: Also tell us, what third party dependencies does this feature require?
placeholder: foobar v1000
validations:
required: false
- type: checkboxes
id: contribution-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [contribution guidelines](https://github.com/sandialabs/OpenCSP/blob/main/CONTRIBUTING.md).
options:
- label: I agree to follow this project's contribution guidelines
required: true
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Purpose

_Please briefly describe the purpose of this pull request. If this fixes a github issue please include `e.g. fixes #22` so that the issue gets closed automatically when this is merged._

## Summary of changes

_Please summarize the code changes in this pull request._

## Implementation notes

_Please describe any relevant implementation details for reviewers, e.g. how correctness was verified._

## Submission checklist
- [ ] Target branch is `develop`, not `main`
- [ ] Existing tests are updated or new tests were added
- [ ] `opencsp/test/test_DocStringsExist.py` are verified to include this change or have been updated accordingly
- [ ] .rst file(s) under `doc/` are verified to include this change or have been updated accordingly

## Additional information

_Please provide any additional information here._

0 comments on commit b58f65b

Please sign in to comment.