From 7766bf9c99dd8cfb304852a20b284a5a5fcf4a71 Mon Sep 17 00:00:00 2001 From: Mccree Lee <2935876049@qq.com> Date: Wed, 22 May 2024 19:47:40 +0800 Subject: [PATCH 1/3] chore: Bug & Feat issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 32 ------------ .github/ISSUE_TEMPLATE/feature-request.yml | 36 +++++++++++++ 3 files changed, 95 insertions(+), 32 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..bd05a65a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,59 @@ +name: Bug Report +description: Submit bug reports to help improve +title: "[Bug] " +labels: + - Bug +body: + - type: checkboxes + attributes: + label: Check the following items + options: + - label: I have looked up relevant Issue + required: false + - label: I've read [How To Ask Questions](https://github.com/betaseeker/How-To-Ask-Questions) + required: false + - type: textarea + id: description + attributes: + label: Description of the issue + description: Please describe in detail the problems encountered. If applicable, add screenshots to help explain your problem. + validations: + required: true + - type: input + id: version + attributes: + label: Package Version + description: Enter the version you are using + placeholder: E.g. 6.0.0-beta6 + validations: + required: true + - type: input + id: environment + attributes: + label: Environment + description: Platform or environment where the bug occurs + placeholder: E.g. Windows 11 22631 + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduction + description: Describe in detail the reproduction + placeholder: If unable to reproduce, enter "unable to reproduce" + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Information + description: Add any other context about the problem here + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d6cb27af6..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -** Environment -- OS -- Avalonia-Version - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..4107d1c00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Submit a new feature request +title: "[Feat] " +labels: + - Enhancement +body: + - type: checkboxes + attributes: + label: Check the following items + options: + - label: I have looked up relevant Issue + required: false + - label: I've read [How To Ask Questions](https://github.com/betaseeker/How-To-Ask-Questions) + required: false + - type: textarea + id: description + attributes: + label: Description of new feature + description: Please describe the new features in detail + validations: + required: true + - type: input + id: version + attributes: + label: Package Version + description: Enter the version you are using + placeholder: E.g. 6.0.0-beta6 + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Information + description: Add any other context about the problem here + validations: + required: false \ No newline at end of file From 9505938f3abaa6355736b18a7b47477803f20308 Mon Sep 17 00:00:00 2001 From: Mccree Lee <2935876049@qq.com> Date: Wed, 22 May 2024 20:00:34 +0800 Subject: [PATCH 2/3] build: SukiUI CI test --- .github/workflows/build.yml | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..874122167 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,38 @@ +name: "SukiUI Continuous Integration" + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + env: + Project_Path: SukiUI/SukiUI.csproj + Dll_Path: publish/SukiUI.dll + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install .Net 8 + uses: actions/setup-dotnet@v4 + with: + dotnet-version: 8.0.x + + - name: Restore + run: dotnet restore ${{ env.Project_Path }} + + - name: Build + run: dotnet build ${{ env.Project_Path }} -c Release --no-restore + + - name: Publish + run: dotnet publish ${{ env.Project_Path }} -c Release -o "publish/" -p:AssemblyVersion=1.0.0.0 + + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: SukiUI-dev + path: ${{ env.Dll_Path }} \ No newline at end of file From 706c3ae43550f1ac2f09be6616587f3392970052 Mon Sep 17 00:00:00 2001 From: Mccree Lee <2935876049@qq.com> Date: Wed, 22 May 2024 20:10:08 +0800 Subject: [PATCH 3/3] doc: Getting Started in README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a03a5b15a..979249b3f 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,18 @@
+## 🚀 Getting Started + +### Install via Nuget (Recommended) + +Visit [SukiUI on Nuget.org](https://www.nuget.org/packages/SukiUI) + +### Add `.dll` reference via Github Action + +[![SukiUI Continuous Integration](https://github.com/kikipoulet/SukiUI/actions/workflows/build.yml/badge.svg)](https://github.com/kikipoulet/SukiUI/actions/workflows/build.yml) + +Download `SukiUI-dev` in artifacts + ## 📱 UI Theme ##### SukiUI contains a theme for AvaloniaUI's base controls with support for Light/Dark themes.