From 2ec154802970af8b67cf5b7d22b9ca7695314202 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 3 Jul 2024 14:22:18 -0600 Subject: [PATCH 1/6] Add initial templates --- .github/ISSUE_TEMPLATE/code-bug-report.yml | 74 +++++++++++++++++ .../ISSUE_TEMPLATE/code-feature-request.yml | 63 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 ++ .github/ISSUE_TEMPLATE/data-bug-report.yml | 82 +++++++++++++++++++ .../ISSUE_TEMPLATE/data-feature-request.yml | 63 ++++++++++++++ 5 files changed, 288 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/code-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/code-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/data-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/data-feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/code-bug-report.yml b/.github/ISSUE_TEMPLATE/code-bug-report.yml new file mode 100644 index 000000000..e0a27002a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code-bug-report.yml @@ -0,0 +1,74 @@ +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@example.com + 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! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - develop@5fd52b5 + - main@8c65300 + default: 0 + 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 diff --git a/.github/ISSUE_TEMPLATE/code-feature-request.yml b/.github/ISSUE_TEMPLATE/code-feature-request.yml new file mode 100644 index 000000000..b1b3924e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code-feature-request.yml @@ -0,0 +1,63 @@ +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@example.com + validations: + required: false + - type: textarea + id: feature-description + attributes: + label: Feature + description: Also, describe the feature you would like. + placeholder: Describe what you want! + value: "42!" + 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. + value: "42!" + 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 + value: "42!" + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..e32b705cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/data-bug-report.yml b/.github/ISSUE_TEMPLATE/data-bug-report.yml new file mode 100644 index 000000000..355d1e1f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/data-bug-report.yml @@ -0,0 +1,82 @@ +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@example.com + 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! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - develop@5fd52b5 + - main@8c65300 + default: 0 + 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 diff --git a/.github/ISSUE_TEMPLATE/data-feature-request.yml b/.github/ISSUE_TEMPLATE/data-feature-request.yml new file mode 100644 index 000000000..e8a1f819e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/data-feature-request.yml @@ -0,0 +1,63 @@ +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@example.com + validations: + required: false + - type: textarea + id: feature-description + attributes: + label: Feature + description: Also, describe the feature you would like. + placeholder: Describe what you want! + value: "42!" + 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. + value: "42!" + 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 + value: "42!" + 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 From 13e958696127f091c0c8f5bf05307e45b1e88917 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 3 Jul 2024 16:36:46 -0600 Subject: [PATCH 2/6] Fix placeholders --- .github/ISSUE_TEMPLATE/data-feature-request.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/data-feature-request.yml b/.github/ISSUE_TEMPLATE/data-feature-request.yml index e8a1f819e..7cec76e6c 100644 --- a/.github/ISSUE_TEMPLATE/data-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/data-feature-request.yml @@ -23,16 +23,15 @@ body: label: Feature description: Also, describe the feature you would like. placeholder: Describe what you want! - value: "42!" validations: required: true - type: textarea id: requirements attributes: - label: Feature + label: Requirements description: Also tell us, what are your requirements? placeholder: As a X, I need to Y, so that I can Z. - value: "42!" + value: "As a X, I need to Y, so that I can Z." validations: required: true - type: dropdown From 47af3d7847b343cf30cf16a481d7f6e188d50f34 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 3 Jul 2024 16:38:23 -0600 Subject: [PATCH 3/6] Fix placeholders --- .github/ISSUE_TEMPLATE/code-bug-report.yml | 1 - .github/ISSUE_TEMPLATE/code-feature-request.yml | 3 --- .github/ISSUE_TEMPLATE/data-bug-report.yml | 1 - .github/ISSUE_TEMPLATE/data-feature-request.yml | 2 -- 4 files changed, 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/code-bug-report.yml b/.github/ISSUE_TEMPLATE/code-bug-report.yml index e0a27002a..a21aa1ca9 100644 --- a/.github/ISSUE_TEMPLATE/code-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/code-bug-report.yml @@ -23,7 +23,6 @@ body: label: What happened? description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! - value: "A bug happened!" validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/code-feature-request.yml b/.github/ISSUE_TEMPLATE/code-feature-request.yml index b1b3924e1..c2bb25f2c 100644 --- a/.github/ISSUE_TEMPLATE/code-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/code-feature-request.yml @@ -23,7 +23,6 @@ body: label: Feature description: Also, describe the feature you would like. placeholder: Describe what you want! - value: "42!" validations: required: true - type: textarea @@ -32,7 +31,6 @@ body: label: Feature description: Also tell us, what are your requirements? placeholder: As a X, I need to Y, so that I can Z. - value: "42!" validations: required: true - type: dropdown @@ -50,7 +48,6 @@ body: label: Dependencies description: Also tell us, what third party dependencies does this feature require? placeholder: foobar v1000 - value: "42!" validations: required: false - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/data-bug-report.yml b/.github/ISSUE_TEMPLATE/data-bug-report.yml index 355d1e1f3..5204fac36 100644 --- a/.github/ISSUE_TEMPLATE/data-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/data-bug-report.yml @@ -23,7 +23,6 @@ body: label: What happened? description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! - value: "A bug happened!" validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/data-feature-request.yml b/.github/ISSUE_TEMPLATE/data-feature-request.yml index 7cec76e6c..ad346da57 100644 --- a/.github/ISSUE_TEMPLATE/data-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/data-feature-request.yml @@ -31,7 +31,6 @@ body: label: Requirements description: Also tell us, what are your requirements? placeholder: As a X, I need to Y, so that I can Z. - value: "As a X, I need to Y, so that I can Z." validations: required: true - type: dropdown @@ -49,7 +48,6 @@ body: label: Dependencies description: Also tell us, what third party dependencies does this feature require? placeholder: foobar v1000 - value: "42!" validations: required: false - type: checkboxes From 4c660785f2e82874fb2a274828aab7b2a4fed06b Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 11 Sep 2024 09:25:06 -0600 Subject: [PATCH 4/6] .github/ISSUE_TEMPALTE: Adjust software rev options --- .github/ISSUE_TEMPLATE/code-bug-report.yml | 7 ++----- .github/ISSUE_TEMPLATE/data-bug-report.yml | 7 ++----- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/code-bug-report.yml b/.github/ISSUE_TEMPLATE/code-bug-report.yml index a21aa1ca9..2f418749b 100644 --- a/.github/ISSUE_TEMPLATE/code-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/code-bug-report.yml @@ -25,15 +25,12 @@ body: placeholder: Tell us what you see! validations: required: true - - type: dropdown + - type: textarea id: version attributes: label: Version description: What version of our software are you running? - options: - - develop@5fd52b5 - - main@8c65300 - default: 0 + placeholder: develop@c481fdc validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/data-bug-report.yml b/.github/ISSUE_TEMPLATE/data-bug-report.yml index 5204fac36..9177caec2 100644 --- a/.github/ISSUE_TEMPLATE/data-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/data-bug-report.yml @@ -25,15 +25,12 @@ body: placeholder: Tell us what you see! validations: required: true - - type: dropdown + - type: textarea id: version attributes: label: Version description: What version of our software are you running? - options: - - develop@5fd52b5 - - main@8c65300 - default: 0 + placeholder: develop@c481fdc validations: required: true - type: dropdown From 005a0689dd599306e00f696c8c2cc13aa3a437f5 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 11 Sep 2024 13:15:28 -0600 Subject: [PATCH 5/6] .github: Added PR template --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..1a342a819 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## 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 +- [ ] 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._ \ No newline at end of file From 4f0b0b2aa2f3796ef88f4998cea60631d4440477 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 11 Sep 2024 13:59:15 -0600 Subject: [PATCH 6/6] .github: Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1a342a819..47073dada 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,6 +11,7 @@ _Please summarize the code changes in this pull request._ _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