Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge form changes from main into development #142

Merged
merged 25 commits into from
Nov 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
df2208d
Merge pull request #102 from T0pCyber/Development
T0pCyber Mar 30, 2023
2acb181
Feature/129 add initial user feature request form
jonnybottles Nov 1, 2024
2b18e31
feature/129 Add config.yaml
jonnybottles Nov 1, 2024
8cbca27
Temporarily disable CI/CD checks
jonnybottles Nov 1, 2024
ba99d2d
Undo changes to build / validate.yml files.
jonnybottles Nov 1, 2024
8d37e86
feature/129: Add dev bug report and feature request forms. Add user f…
jonnybottles Nov 1, 2024
daa481b
Merge branch 'feature/129-create-interactive-user-feature-request-form'
jonnybottles Nov 1, 2024
ec77e8b
Moved dev feature request form.
jonnybottles Nov 1, 2024
416ce72
Moved dev bug request form.
jonnybottles Nov 1, 2024
1edc82c
Update config to have dev bug report form.
jonnybottles Nov 1, 2024
efa29fc
Combine user and dev feature request form.
jonnybottles Nov 1, 2024
61b3be1
Remove related feature request field
jonnybottles Nov 1, 2024
ad19b38
Update config file.
jonnybottles Nov 1, 2024
bd21872
Remove dev bug form
jonnybottles Nov 1, 2024
3308571
Remove external linked field from bug form
jonnybottles Nov 1, 2024
e0a5284
Remove .md request forms.
jonnybottles Nov 1, 2024
fc5abf4
Add question form.
jonnybottles Nov 1, 2024
d06db85
Remove old question form.
jonnybottles Nov 1, 2024
f87f5f4
Add documentation issue template.
jonnybottles Nov 1, 2024
334ef78
Add documentation issue template.
jonnybottles Nov 1, 2024
7cc9d93
Change suggest a feature to request a feature.
jonnybottles Nov 1, 2024
ccb7ab1
Rearange order of requests.
jonnybottles Nov 1, 2024
ca03abb
Rearange order of requests in config.yaml
jonnybottles Nov 1, 2024
30c9d31
Rearange order of requests in config.yaml and update file names rearr…
jonnybottles Nov 1, 2024
83182b3
Add GITHUB_TOKEN write access test workflow
jonnybottles Nov 2, 2024
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
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature_request_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "💡 Request a Feature"
description: "Suggest a new feature or improvement for Hawk"
title: "Feature: "
labels: ["type/feature", "status/backlog"]
body:
- type: textarea
id: problem
attributes:
label: What problem would this feature solve?
placeholder: "Clear description of the current limitation/problem"
validations:
required: true
- type: textarea
id: solution
attributes:
label: "Proposed Solution"
description: "How would you like this to work?"
validations:
required: true
- type: markdown
attributes:
value: "---

### ⚙️ Developer Section (For Hawk Team Members Only)

*The following sections are for internal use by the Hawk development team. Users can ignore these fields.*"
- type: textarea
id: technical-requirements
attributes:
label: "Technical Requirements"
description: "Detailed feature requirements"
validations:
required: false
- type: textarea
id: implementation-approach
attributes:
label: "Implementation Approach"
description: "Technical approach and architecture changes"
validations:
required: false
- type: textarea
id: acceptance-criteria
attributes:
label: "Acceptance Criteria"
description: "Specific conditions that must be met"
validations:
required: false
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/02_bug_report_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: "🐛 Report a Bug"
description: "Report a bug or problem with Hawk"
title: "Bug: "
labels: ["type/bug", "status/backlog"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug in Hawk!
- type: textarea
id: description
attributes:
label: "What happened?"
description: "Describe what you were doing and what went wrong"
placeholder: "Clear, concise description of the issue"
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: "Steps to Reproduce"
description: "How can we reproduce this issue?"
placeholder: |
1. Run command '...'
2. With parameters '...'
3. See error
validations:
required: true
- type: input
id: version
attributes:
label: "Hawk Version"
description: "What version of Hawk are you running?"
placeholder: "e.g., 1.2.0"
validations:
required: true
- type: markdown
attributes:
value: |
---

### 🔧 Developer Section (For Hawk Team Members Only)

*The following sections are for internal use by the Hawk development team. Users can ignore these fields.*
- type: textarea
id: technical-analysis
attributes:
label: "Technical Analysis"
description: "Root cause analysis"
validations:
required: false
- type: textarea
id: implementation-plan
attributes:
label: "Implementation Plan"
description: "Proposed fix approach"
validations:
required: false
- type: textarea
id: acceptance-criteria
attributes:
label: "Acceptance Criteria"
description: "What needs to be true for this to be resolved?"
validations:
required: false
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/03_documentation_update_form.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# documentation.yml
name: "📚 Documentation Update"
description: "Report issues with documentation or request updates"
title: "Docs: "
labels: ["type/documentation", "status/backlog"]
body:
- type: textarea
id: documentation-issue
attributes:
label: "What needs to be updated?"
description: "Describe what documentation needs to be added, updated, or fixed"
placeholder: "Clear description of documentation changes needed"
validations:
required: true

- type: textarea
id: proposed-changes
attributes:
label: "Proposed Changes"
description: "What changes would you like to see?"
placeholder: "Specific suggestions for documentation updates"
validations:
required: true

- type: input
id: current-page
attributes:
label: "Current Documentation Link"
description: "If this is about existing documentation, provide the link"
placeholder: "https://github.com/T0pcyber/Hawk/wiki/page-name"
validations:
required: false

- type: markdown
attributes:
value: |
---

### 📝 Developer Section (For Hawk Team Members Only)

*The following sections are for internal use by the Hawk development team. Users can ignore these fields.*

- type: textarea
id: implementation-plan
attributes:
label: "Implementation Plan"
description: "How should these documentation changes be implemented?"
validations:
required: false

- type: textarea
id: additional-resources
attributes:
label: "Additional Resources"
description: "Related documents, screenshots, or examples needed"
validations:
required: false

- type: textarea
id: acceptance-criteria
attributes:
label: "Acceptance Criteria"
description: "What needs to be true for this documentation update to be complete?"
validations:
required: false
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/04_question_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "❓ Ask a Question"
description: "Have a question about Hawk? Ask it here!"
title: "Question: "
labels: ["type/question", "status/backlog"]
body:
- type: textarea
id: question
attributes:
label: "Your Question"
description: "Please provide a clear and concise question."
placeholder: "Type your question here..."
validations:
required: true
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: "💡 Request a Feature"
url: https://github.com/T0pcyber/Hawk/issues/new?template=01_feature_request_form.yml
about: "Have an idea for improvement? Let us know"
- name: "🐛 Report a Bug"
url: https://github.com/T0pcyber/Hawk/issues/new?template=02_bug_report_form.yml
about: "Found a bug? Report it here"
- name: "📚 Documentation Issue"
url: https://github.com/T0pcyber/Hawk/issues/new?template=03_documentation_update_form.yml
about: "Report issues with documentation or request updates"
- name: "❓ Ask a Question"
url: https://github.com/T0pcyber/Hawk/issues/new?template=04_question_form.yml
about: "Have a question about Hawk? Ask it here!"
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

25 changes: 12 additions & 13 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@ on:

jobs:
build:

runs-on: windows-2019

steps:
- uses: actions/checkout@v1
- name: Install Prerequisites
run: .\build\vsts-prerequisites.ps1
shell: powershell
- name: Validate
run: .\build\vsts-validate.ps1
shell: powershell
- name: Build
run: .\build\vsts-build.ps1 -ApiKey $env:APIKEY
shell: powershell
env:
APIKEY: ${{ secrets.ApiKey }}
- uses: actions/checkout@v1
- name: Install Prerequisites
run: .\build\vsts-prerequisites.ps1
shell: powershell
- name: Validate
run: .\build\vsts-validate.ps1
shell: powershell
- name: Build
run: .\build\vsts-build.ps1 -ApiKey $env:APIKEY
shell: powershell
env:
APIKEY: ${{ secrets.ApiKey }}
17 changes: 17 additions & 0 deletions .github/workflows/test-github-token-write.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Test GITHUB_TOKEN Write Access

on:
workflow_dispatch: # Allows you to manually trigger this test

jobs:
test-write-access:
runs-on: ubuntu-latest
steps:
- name: Test GITHUB_TOKEN Write Access
env:
ISSUE_NUMBER: 138 # Replace with an existing issue number in your repository
run: |
curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
-X POST \
-d '{"body": "Testing GITHUB_TOKEN write access"}' \
"https://api.github.com/repos/${{ github.repository }}/issues/${ISSUE_NUMBER}/comments"
15 changes: 7 additions & 8 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ on: [pull_request]

jobs:
validate:

runs-on: windows-2019

steps:
- uses: actions/checkout@v1
- name: Install Prerequisites
run: .\build\vsts-prerequisites.ps1
shell: powershell
- name: Validate
run: .\build\vsts-validate.ps1
shell: powershell
- uses: actions/checkout@v1
- name: Install Prerequisites
run: .\build\vsts-prerequisites.ps1
shell: powershell
- name: Validate
run: .\build\vsts-validate.ps1
shell: powershell
Loading