From d757bbea15e259edf21de3f0e40ade086d877691 Mon Sep 17 00:00:00 2001 From: nwdepatie Date: Thu, 4 Jan 2024 22:32:30 -0500 Subject: [PATCH] Adding in GitHub Admin --- .github/ISSUE_TEMPLATE/bug-form.yml | 34 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/epic.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 26 +++++++++ .github/ISSUE_TEMPLATE/other.yml | 18 ++++++ .github/ISSUE_TEMPLATE/spike.yml | 38 +++++++++++++ .github/ISSUE_TEMPLATE/task.yml | 25 +++++++++ .github/pull_request_template.md | 36 ++++++++++++ .github/workflows/build-check.yml | 20 +++++++ 9 files changed, 262 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-form.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/epic.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/other.yml create mode 100644 .github/ISSUE_TEMPLATE/spike.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/build-check.yml diff --git a/.github/ISSUE_TEMPLATE/bug-form.yml b/.github/ISSUE_TEMPLATE/bug-form.yml new file mode 100644 index 0000000..f3df30d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-form.yml @@ -0,0 +1,34 @@ +name: Bug +description: For any issue related to a bug +title: '[Area] - Short Description' +labels: [bug] +body: + - type: textarea + id: observed-behavior + attributes: + label: Observed Behavior + description: What happened? + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What should have happened? + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: How could someone reproduce this bug? + value: "1. \n2. \n3. " + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots (as needed) + description: Add screenshots of the bug if applicable + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml new file mode 100644 index 0000000..1827d9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -0,0 +1,64 @@ +name: Epic +description: A collection of many tasks +title: '[Area] - Short Description' +labels: [epic] +body: + - type: textarea + id: overview + attributes: + label: Overview + description: Provide a brief summary of this epic + validations: + required: true + - type: textarea + id: stakeholders + attributes: + label: Stakeholders + description: Who to contact for this epic? + value: | + Product Stakeholder: + Software Stakeholder: + Reference Users: + - type: textarea + id: metrics + attributes: + label: Success Metrics + description: What are the metrics we will use to determine if this is successful? + validations: + required: true + - type: textarea + id: rollout + attributes: + label: Rollout Plan + description: How will this be released? All at once? In parts? + validations: + required: true + - type: textarea + id: scope + attributes: + label: Out of Scope + description: What is not included in this epic? + validations: + required: true + - type: textarea + id: background-context + attributes: + label: Background / Context + description: What is the context for this epic? What already exists? + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: Acceptance Criteria + description: How are we evaluating the success of this epic? + validations: + required: true + - type: textarea + id: tickets + attributes: + label: Tickets + description: What tickets will be a part of this epic? + value: " - [ ] #\n - [ ] #" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..4b491b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,26 @@ +name: Feature Request +description: Suggest a new feature for the project +title: '[Area] - Short Description' +labels: [new feature] +body: + - type: textarea + id: current-features + attributes: + label: Current Features + description: What exists currently? + validations: + required: true + - type: textarea + id: desired-features + attributes: + label: Desired Additional Features + description: What features do you want to add? + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots (as needed) + description: Add screenshots of the current or desired state if applicable + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 0000000..7df8945 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,18 @@ +name: Other +description: For issues that don't fit the other categories +title: '[Area] - Short Description' +body: + - type: textarea + id: desired-changes + attributes: + label: Desired Changes + description: What changes do you want to make? + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots (as needed) + description: Add screenshots if applicable + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/spike.yml b/.github/ISSUE_TEMPLATE/spike.yml new file mode 100644 index 0000000..f5dc1c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spike.yml @@ -0,0 +1,38 @@ +name: Spike +description: For any research or investigation into a feature or our current architecture +title: '[Area] - Short Description' +labels: [spike] +body: + - type: markdown + attributes: + value: For a spike ticket, please make sure to remember to add links to the resources you are pulling information from so others who are reviewing and giving feedback can also take a look at the same information you are looking at. + - type: dropdown + id: spike-type + attributes: + label: Spike Type + description: Is this spike about the product (functional) or the implementation of the product (technical)? + multiple: true + options: + - Functional + - Technical + - type: textarea + id: goal + attributes: + label: Goal + description: What is this spike ticket looking into/trying to solve? Is this about enhancing something we currently do or looking into a new feature? + validations: + required: true + - type: textarea + id: purpose + attributes: + label: Reason for Spike + description: Why is this spike ticket necessary? + validations: + required: true + - type: textarea + id: sidenotes + attributes: + label: Additional notes + description: Add any extra comments related to the spike. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..81bd791 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,25 @@ +name: Task +description: Create a task that a developer can complete. +title: '[Area] - Short Description' +body: + - type: textarea + id: description + attributes: + label: Description + description: Provide a brief summary of this issue + validations: + required: true + - type: textarea + id: acceptance-criteria + attributes: + label: Acceptance Criteria + description: What are the conditions that need to be satisified to complete this task? + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: How will this solution be implemented? What will be changed or added? + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..5c723e3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +## Changes + +_Explanation of changes goes here_ + +## Notes + +_Any other notes go here_ + +## Test Cases + +- Case A +- Edge case +- ... + +## To Do + +_Any remaining things that need to get done_ + +- [ ] item 1 +- [ ] ... + +## Checklist + +It can be helpful to check the `Checks` and `Files changed` tabs. +Please reach out to your Project Lead if anything is unclear. +Please request reviewers and ping on slack only after you've gone through this whole checklist. + +- [ ] All commits are tagged with the ticket number +- [ ] No merge conflicts +- [ ] All checks passing +- [ ] Remove any non-applicable sections of this template +- [ ] Assign the PR to yourself +- [ ] Request reviewers & ping on Slack +- [ ] PR is linked to the ticket (fill in the closes line below) + +Closes # (issue #) diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yml new file mode 100644 index 0000000..4dec4f0 --- /dev/null +++ b/.github/workflows/build-check.yml @@ -0,0 +1,20 @@ +name: Build +on: [push] +jobs: + run-build: + runs-on: ubuntu-latest + container: + image: nwdepatie/ner-gcc-arm:latest + timeout-minutes: 10 + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: recursive + + - name: Execute Make + run: | + if ! make; then + echo "The application has failed to build." + exit 1 # This will cause the workflow to fail + fi \ No newline at end of file