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

Readme, Issues templates, Github Action #13

Merged
merged 3 commits into from
Oct 6, 2024
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
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Bug Report
description: Report a bug or issue.
title: "[Bug]: "
labels: ["bug", "triage"]
projects: []
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report an issue! Please fill out the form below to help us understand the problem better.

- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more information?
placeholder: Enter your email
validations:
required: false

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the problem and what you expected to happen.
placeholder: Tell us what you see!
validations:
required: true

# - type: dropdown
# id: version
# attributes:
# label: Version
# description: What version of our software are you using?
# options:
# - 1.0.0
# - 1.0.1
# - 1.0.2
# default: 1.0.0
# validations:
# required: true

# - type: checkboxes
# id: browsers
# attributes:
# label: Which browsers are you experiencing the problem on?
# multiple: true
# options:
# - Firefox
# - Chrome
# - Safari
# - Microsoft Edge
# validations:
# required: true

- type: textarea
id: logs
attributes:
label: Relevant Log Output
description: Please paste any relevant log output here. It will be automatically formatted as code.
# render: shell
placeholder: Paste logs here
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to abide by our [Code of Conduct](https://example.com).
options:
- label: I agree to follow this project's Code of Conduct
required: true
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature Request
description: Suggest a new feature or enhancement.
title: "[Feature]: "
labels: ["enhancement", "discussion"]
projects: []
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for your suggestion! Please describe your idea in as much detail as possible.

- type: input
id: feature-title
attributes:
label: Feature Title
description: Provide a brief title for the new feature or enhancement.
placeholder: Enter the title
validations:
required: true

- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Describe how the new feature or enhancement should work.
placeholder: Describe your idea here
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe how this feature can be used and what problems it solves.
placeholder: Describe the use case
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to abide by our [Code of Conduct](https://example.com).
options:
- label: I agree to follow this project's Code of Conduct
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community Support
url: https://github.com/orgs/community/discussions
about: Please ask and answer questions here.
9 changes: 7 additions & 2 deletions .github/workflows/sonarcloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,14 @@ jobs:
- name: UI Unit Tests
run: yarn test:coverage

- name: Extract version from tag
- name: Extract version from tag or branch
id: version
run: echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
else
echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
fi

- name: SonarCloud Scan
uses: sonarsource/sonarcloud-github-action@master
Expand Down
Loading