und - Introducing ChemiStar!

---

Type: und
Breaking: False
Doc Required: False
Backport Required: False
Part: 1/1

.editorconfig

@@ -0,0 +1,48 @@
+root = true
+
+[*]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+file_header_template = \nChemiStar  Copyright (C) 2024  Aptivi\n\nThis file is part of ChemiStar\n\nChemiStar is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nChemiStar is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY, without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <https://www.gnu.org/licenses/>.\n
+
+# IDE0060: Remove unused parameter
+dotnet_diagnostic.IDE0060.severity = warning
+dotnet_diagnostic.CA1822.severity  = none
+
+[*.md]
+charset = utf-8
+
+[*.sh]
+end_of_line = lf
+
+[*.resx]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.csproj]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.xml]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.json]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+[*.yml]
+end_of_line = crlf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

.github/ISSUE_TEMPLATE/ask-a-question.md

@@ -0,0 +1,19 @@
+---
+name: Ask a question
+about: Ask us anything about KS.
+title: "[Q&A] [FeatureName] - [Question]"
+labels: ''
+assignees: ''
+
+---
+
+### Type of question
+<!-- Select the type of the question that you're going to ask here. -->
+- [ ] General
+- [ ] API
+- [ ] Commands
+- [ ] Mods
+- [ ] Others
+
+### Question
+<!-- Ask us a question here. Be descriptive as much as you can. -->

.github/ISSUE_TEMPLATE/report-an-issue.md

@@ -0,0 +1,30 @@
+---
+name: Report an issue
+about: Thank you for reporting a bug to us.
+title: "[BUG] [featureName] - [issue]"
+labels: ''
+assignees: ''
+
+---
+
+### Description
+<!-- Describe how this bug happened, and general information about it. Note that you need to be as descriptive as possible. -->
+
+
+### Expected behavior
+<!-- How do you expect this program to behave? -->
+
+
+### Actual behavior
+<!-- What did it do instead? -->
+
+
+### Steps to reproduce
+<!-- Provide clear step-by-step instructions about reproducing this bug. -->
+1. Open x
+1. Write `yyy`
+1. Observe a happening instead of z
+
+### Version
+<!-- This should be in this format: <Version> (<Commit>) (<Branch>). Commit number and branch required for development builds. -->
+Version `0.0.0 0000000000000000000000000000000000000000 main`

.github/ISSUE_TEMPLATE/request-a-feature.md

@@ -0,0 +1,19 @@
+---
+name: Request a feature
+about: Suggest an idea to us.
+title: "[ADD] [FeatureName] - [Feature]"
+labels: ''
+assignees: ''
+
+---
+
+### Description of new feature
+<!-- Explain about a new feature here. -->
+
+
+### What does it add?
+- [ ] New feature
+- [ ] New API functions
+- [ ] Others
+
+### Have you tried doing it? If so, attach a mod file.

.github/issue_template.md

@@ -0,0 +1,21 @@
+### Description
+<!-- Describe how this bug happened, and general information about it. Note that you need to be as descriptive as possible. -->
+
+
+### Expected behavior
+<!-- How do you expect this program to behave? -->
+
+
+### Actual behavior
+<!-- What did it do instead? -->
+
+
+### Steps to reproduce
+<!-- Provide clear step-by-step instructions about reproducing this bug. -->
+1. Open x
+1. Write `yyy`
+1. Observe a happening instead of z
+
+### Version
+<!-- This should be in this format: <Version> (<Commit>) (<Branch>). Commit number and branch required for development builds. -->
+Version `0.0.0 0000000000000000000000000000000000000000 main`

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+<!-- Talk about your pull request. Note that you need to be as descriptive as possible. -->
+
+
+## Change type
+<!-- Specify what kind of changes you made. -->
+- [ ] Bug fixes
+- [ ] Performance improvements
+- [ ] Feature changes
+- [ ] Behavioral changes
+- [ ] Other (specify)
+
+## Tested?
+<!-- Have you tested your changes? -->
+- [ ] Yes, I have
+- [ ] No, I haven't
+- [ ] Not sure
+
+## Other changes?
+<!-- Specify the changes that don't fit to the categories above. -->

.github/workflows/build-rel.yml

@@ -0,0 +1,34 @@
+name: Build Project (Release)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        runs-on: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Solution Compilation (Windows)
+        if: matrix.runs-on == 'windows-latest'
+        run: cd tools ; ./build.cmd ; cd ..
+      - name: Solution Compilation (Unix)
+        if: matrix.runs-on != 'windows-latest'
+        run: make
+      - name: Testing
+        run: dotnet test --no-build --configuration Release
+

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build Project (Debug)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        runs-on: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Solution Compilation (Windows)
+        if: matrix.runs-on == 'windows-latest'
+        run: cd tools ; ./build.cmd Debug ; cd ..
+      - name: Solution Compilation (Unix)
+        if: matrix.runs-on != 'windows-latest'
+        run: make dbg
+      - name: Testing
+        run: dotnet test --no-build --configuration Debug
+

.github/workflows/docgen.yml

@@ -0,0 +1,32 @@
+name: API Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: "Make API Reference"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        name: Fetching the source
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Setup DocFX
+        run: dotnet tool install --global docfx
+      - name: Generating Documentation
+        run: make doc
+      - name: Saving changes to gh-pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          commit_message: "Updated documentation to reflect latest changes"
+          personal_token: ${{ secrets.DOCGEN_TOKEN }}
+          publish_dir: ./docs/
+          publish_branch: gh-pages

.github/workflows/pack.yml

@@ -0,0 +1,30 @@
+name: NuGet Gallery Push
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Notify build
+        uses: tsickert/[email protected]
+        with:
+          webhook-url: ${{ secrets.WEBHOOK_URL }}
+          content: "<:nitrocidks:1268905174563557452> ${{ github.event.release.name }} <:nitrocidks:1268905174563557452>\n\n${{ github.event.release.body }}"
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Solution Compilation
+        run: make
+      - name: Package Publication
+        run: |
+          chmod +x tools/*.sh
+          cd tools ; NUGET_APIKEY=${{ secrets.NUGET_APIKEY }} ./push.sh ; cd ..

.github/workflows/prepdraft.yml

@@ -0,0 +1,35 @@
+name: Prepare release draft
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Setup DocFX
+        run: dotnet tool install --global docfx
+      - name: Release Asset Preparation
+        run: |
+          chmod +x tools/*.sh
+          make doc
+          cd tools ; ./docgen-pack.sh ; cd ..
+      - name: Release Draft Making
+        uses: softprops/action-gh-release@v2
+        with:
+          body: "This is a draft release. Fill this with a release snippet from the release sheet made internally."
+          draft: true
+          files: |
+            tools/*.zip