feat: ✅ add test and example code

.github/workflows/publish.yml → .github/workflows/release.yml

@@ -2,7 +2,7 @@ name: publish
 
 on:
   push:
-    branches: [ publish ]
+    branches: [ release/** ]
 
 jobs:
   publish_nuget_package:
@@ -11,7 +11,7 @@ jobs:
     - name: Fetch code
       uses: actions/checkout@v3
     - name: Setup dotnet
-      uses: actions/setup-dotnet@v2
+      uses: actions/setup-dotnet@v3
       with:
         dotnet-version: | 
           3.1.x

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Fetch code
       uses: actions/checkout@v3
     - name: Setup dotnet
-      uses: actions/setup-dotnet@v2
+      uses: actions/setup-dotnet@v3
       with:
         dotnet-version: | 
           3.1.x
@@ -23,6 +23,4 @@ jobs:
       run: dotnet build "./CSharp/FrameRateTask/FrameRateTask.csproj" -c Release
     - name: Run test code
       run: |
-        dotnet build "./CSharp/Test/Test.csproj" -c Release
-        dotnet build "./CSharp/TestConcurrency/TestConcurrency.csproj" -c Release
-        dotnet run --project "./CSharp/TestConcurrency/TestConcurrency.csproj" -c Release
+        dotnet test "./FrameRateTask.sln" -c Release

.gitignore

@@ -1,7 +1,7 @@
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
-## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # User-specific files
 *.rsuser
@@ -29,7 +29,6 @@ x86/
 bld/
 [Bb]in/
 [Oo]bj/
-[Oo]ut/
 [Ll]og/
 [Ll]ogs/
 
@@ -91,6 +90,7 @@ StyleCopReport.xml
 *.tmp_proj
 *_wpftmp.csproj
 *.log
+*.tlog
 *.vspscc
 *.vssscc
 .builds
@@ -294,6 +294,17 @@ node_modules/
 # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
 *.vbw
 
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+*.ncb
+*.aps
+
 # Visual Studio LightSwitch build output
 **/*.HTMLClient/GeneratedArtifacts
 **/*.DesktopClient/GeneratedArtifacts
@@ -350,6 +361,9 @@ ASALocalRun/
 # Local History for Visual Studio
 .localhistory/
 
+# Visual Studio History (VSHistory) files
+.vshistory/
+
 # BeatPulse healthcheck temp database
 healthchecksdb
 
@@ -360,4 +374,25 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml

CONTRIBUTING.md

@@ -2,4 +2,8 @@
 
 ## Branch
 
-You should contribute to dev branch if you want to contribute to this reposity.
+You should contribute to **`dev`** branch if you want to contribute to this repository.
+
+## Commit Specification
+
+Your commit message should follow the [Conventional Commits](https://www.conventionalcommits.org/).

CONTRIBUTING.zh-CN.md

@@ -0,0 +1,10 @@
+# 向 FRAMERATETASK 贡献代码
+
+## 分支
+
+如果想要贡献代码，请向 **`dev`** 分支提出 `pull request`。
+
+## Commit 规范
+
+你的 commit 信息需要遵循[约定式提交](https://www.conventionalcommits.org/zh-hans/)。
+

CSharp/FrameRateTask/Exceptions.cs

@@ -2,10 +2,12 @@
 
  * FrameRateTask
 
- * Copyright © 2022 Timothy-LiuXuefeng
+ * Copyright © 2022 Timothy Liu
 
  * MIT LICENSE
 
+ * https://timothy-liuxf.github.io/FrameRateTask/
+
  */
 
 using System;

CSharp/FrameRateTask/FrameRateTask.cs

@@ -2,10 +2,12 @@
 
  * FrameRateTask
 
- * Copyright © 2022 Timothy-LiuXuefeng
+ * Copyright © 2022 Timothy Liu
 
  * MIT LICENSE
 
+ * https://timothy-liuxf.github.io/FrameRateTask/
+
  */
 
 using System;